pathObject{Object}dir{string}root{string}base{string}name{string}ext{string}
- 返回: {string}
path.format() 方法从对象返回路径字符串。
与 [path.parse()] 相反。
当为 pathObject 提供属性时,注意以下组合,其中一些属性优先于另一些属性:
- 如果提供了
pathObject.dir,则忽略pathObject.root。 - 如果
pathObject.base存在,则忽略pathObject.ext和pathObject.name。
例如,在 POSIX 上:
// 如果提供了 `dir`、`root` 和 `base`,// 则返回 `${dir}${path.sep}${base}`。// `root` 会被忽略。path.format({root: '/ignored',dir: '/home/user/dir',base: 'file.txt'});// 返回: '/home/user/dir/file.txt'// 如果未指定 `dir`,则使用 `root`。// 如果只提供 `root`,或 'dir` 等于 `root`,则将不包括平台分隔符。// `ext` 将被忽略。path.format({root: '/',base: 'file.txt',ext: 'ignored'});// 返回: '/file.txt'// 如果未指定 `base`,则使用 `name` + `ext`。path.format({root: '/',name: 'file',ext: '.txt'});// 返回: '/file.txt'
在 Windows 上:
path.format({dir: 'C:\\path\\dir',base: 'file.txt'});// 返回: 'C:\\path\\dir\\file.txt'
