• 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.extpathObject.name

    例如,在 POSIX 上:

    1. // 如果提供了 `dir`、`root` 和 `base`,
    2. // 则返回 `${dir}${path.sep}${base}`。
    3. // `root` 会被忽略。
    4. path.format({
    5. root: '/ignored',
    6. dir: '/home/user/dir',
    7. base: 'file.txt'
    8. });
    9. // 返回: '/home/user/dir/file.txt'
    10. // 如果未指定 `dir`,则使用 `root`。
    11. // 如果只提供 `root`,或 'dir` 等于 `root`,则将不包括平台分隔符。
    12. // `ext` 将被忽略。
    13. path.format({
    14. root: '/',
    15. base: 'file.txt',
    16. ext: 'ignored'
    17. });
    18. // 返回: '/file.txt'
    19. // 如果未指定 `base`,则使用 `name` + `ext`。
    20. path.format({
    21. root: '/',
    22. name: 'file',
    23. ext: '.txt'
    24. });
    25. // 返回: '/file.txt'

    在 Windows 上:

    1. path.format({
    2. dir: 'C:\\path\\dir',
    3. base: 'file.txt'
    4. });
    5. // 返回: 'C:\\path\\dir\\file.txt'