NodeJs-path模块-基础用户与相关的命令

path.basename(path[, ext])

  • path <string>
  • ext <string> 可选的文件扩展名。
  • 返回: <string>

path.basename() 方法返回 path 的最后一部分,类似于 Unix 的 basename 命令。 尾部的目录分隔符将被忽略.

1
2
3
4
5
path.basename('/foo/bar/baz/asdf/quux.html');
// 返回: 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html');
// 返回: 'quux'

如果 path 不是字符串或者给定了 ext 且不是字符串,则抛出 TypeError

path.delimiter

  • <string>

提供平台特定的路径定界符:

  • ; 用于 Windows
  • : 用于 POSIX

例如,在 POSIX 上:

1
2
3
4
5
console.log(process.env.PATH);
// 打印: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter);
// 返回: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

在 Windows 上:

1
2
3
4
5
console.log(process.env.PATH);
// 打印: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter);
// 返回: ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']

path.dirname(path)

  • path <string>
  • 返回: <string>

path.dirname() 方法返回 path 的目录名,类似于 Unix 的 dirname 命令。 尾部的目录分隔符将被忽略,参阅 path.sep

1
2
path.dirname('/foo/bar/baz/asdf/quux');
// 返回: '/foo/bar/baz/asdf'

如果 path 不是字符串,则抛出 TypeError

path.extname(path)

版本历史

  • path
  • 返回:

path.extname() 方法返回 path 的扩展名,从最后一次出现 .(句点)字符到 path 最后一部分的字符串结束。 如果在 path 的最后一部分中没有 . ,或者如果 path 的基本名称(参阅 path.basename())的第一个字符是 .,则返回空字符串。

1
2
3
4
5
6
7
8
9
10
path.extname('index.html');
// 返回: '.html'
path.extname('index.coffee.md');
// 返回: '.md'
path.extname('index.');
// 返回: '.'
path.extname('index');
// 返回: ''
path.extname('.index');
// 返回: ''

如果 path 不是字符串,则抛出 TypeError

path.format(pathObject)

  • pathObject
    • dir
    • root
    • base
    • name
    • ext
  • 返回:
  • path.format() 方法从对象返回路径字符串。 与 path.parse() 相反。 当为 pathObject 提供属性时,注意以下组合,其中一些属性优先于另一些属性:

    • 如果提供了 pathObject.dir,则忽略 pathObject.root
    • 如果 pathObject.base 存在,则忽略 pathObject.extpathObject.name

    例如,在 POSIX 上:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    // 如果提供了 `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 上:

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

    path.isAbsolute(path)

    • path
    • 返回:

    path.isAbsolute() 方法检测 path 是否为绝对路径。 如果给定的 path 是零长度字符串,则返回 false。 例如,在 POSIX 上:

    1
    2
    3
    4
    path.isAbsolute('/foo/bar'); // true
    path.isAbsolute('/baz/..'); // true
    path.isAbsolute('qux/'); // false
    path.isAbsolute('.'); // false

    在 Windows 上:

    1
    2
    3
    4
    5
    6
    7
    path.isAbsolute('//server');    // true
    path.isAbsolute('\\\\server'); // true
    path.isAbsolute('C:/foo/..'); // true
    path.isAbsolute('C:\\foo\\..'); // true
    path.isAbsolute('bar\\baz'); // false
    path.isAbsolute('bar/baz'); // false
    path.isAbsolute('.'); // false

    如果 path 不是字符串,则抛出 TypeError

    path.join([…paths])

    • ...paths 路径片段的序列。
    • 返回:

    path.join() 方法使用平台特定的分隔符作为定界符将所有给定的 path 片段连接在一起,然后规范化生成的路径。 零长度的 path 片段会被忽略。 如果连接的路径字符串是零长度的字符串,则返回 '.',表示当前工作目录。

    1
    2
    3
    4
    5
    path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');
    // 返回: '/foo/bar/baz/asdf'

    path.join('foo', {}, 'bar');
    // 抛出 'TypeError: Path must be a string. Received {}'

    如果任何路径片段不是字符串,则抛出 TypeError

    path.normalize(path)

    • path
    • 返回:

    path.normalize() 方法规范化给定的 path,解析 '..''.' 片段。 当找到多个连续的路径段分隔字符时(例如 POSIX 上的 /、Windows 上的 \/),则它们将被替换为单个平台特定的路径段分隔符(POSIX 上的 /、Windows 上的 \)。 尾部的分隔符会保留。 如果 path 是零长度的字符串,则返回 '.',表示当前工作目录。 例如,在 POSIX 上:

    1
    2
    path.normalize('/foo/bar//baz/asdf/quux/..');
    // 返回: '/foo/bar/baz/asdf'

    在 Windows 上:

    1
    2
    3
    4
    5
    6
    7
    8
    path.normalize('C:\\temp\\\\foo\\bar\\..\\');
    // 返回: 'C:\\temp\\foo\\'
    ```

    由于 Windows 识别多种路径分隔符,因此这些分隔符都将被替换为 Windows 首选的分隔符(`\`):
    ```js
    path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
    // 返回: 'C:\\temp\\foo\\bar'

    如果 path 不是字符串,则抛出 TypeError

    path.parse(path)

    新增于: v0.11.15

    • path <string>
    • 返回:

      path.parse() 方法返回一个对象,其属性表示 path 的重要元素。 尾部的目录分隔符将被忽略,参阅 path.sep。 返回的对象将具有以下属性:

      • dir <string>
      • root <string>
      • base <string>
      • name <string>
      • ext <string>

      例如,在 POSIX 上:

      1
      2
      3
      4
      5
      6
      7
      path.parse('/home/user/dir/file.txt');
      // 返回:
      // { root: '/',
      // dir: '/home/user/dir',
      // base: 'file.txt',
      // ext: '.txt',
      // name: 'file' }
      1
      2
      3
      4
      5
      6
      ┌─────────────────────┬────────────┐
      │ dir │ base │
      ├──────┬ ├──────┬─────┤
      │ root │ │ name │ ext │
      " / home/user/dir / file .txt "
      └──────┴──────────────┴──────┴─────┘

      (”” 行中的所有空格都应该被忽略,它们纯粹是为了格式化)

      在 Windows 上:

      1
      2
      3
      4
      5
      6
      7
      path.parse('C:\\path\\dir\\file.txt');
      // 返回:
      // { root: 'C:\\',
      // dir: 'C:\\path\\dir',
      // base: 'file.txt',
      // ext: '.txt',
      // name: 'file' }
      1
      2
      3
      4
      5
      6
      ┌─────────────────────┬────────────┐
      │ dir │ base │
      ├──────┬ ├──────┬─────┤
      │ root │ │ name │ ext │
      " C:\ path\dir \ file .txt "
      └──────┴──────────────┴──────┴─────┘

      (”” 行中的所有空格都应该被忽略,它们纯粹是为了格式化)

      如果 path 不是字符串,则抛出 TypeError

      path.posix

      新增于: v0.11.15

      • path.posix 属性提供对 path 方法的 POSIX 特定实现的访问。

        path.relative(from, to)

        • from <string>
        • to <string>
        • 返回: <string>

        path.relative() 方法根据当前工作目录返回 fromto 的相对路径。 如果 fromto 各自解析到相同的路径(分别调用 path.resolve() 之后),则返回零长度的字符串。 如果将零长度的字符串传入 fromto,则使用当前工作目录代替该零长度的字符串。 例如,在 POSIX 上:

        1
        2
        path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
        // 返回: '../../impl/bbb'

        在 Windows 上:

        1
        2
        path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
        // 返回: '..\\..\\impl\\bbb'

        如果 fromto 不是字符串,则抛出 TypeError

        path.resolve([…paths])

        • ...paths <string> 路径或路径片段的序列。
        • 返回: <string>

        path.resolve() 方法将路径或路径片段的序列解析为绝对路径。 给定的路径序列从右到左进行处理,每个后续的 path 前置,直到构造出一个绝对路径。 例如,给定的路径片段序列:/foo/barbaz,调用 path.resolve('/foo', '/bar', 'baz') 将返回 /bar/baz。 如果在处理完所有给定的 path 片段之后还未生成绝对路径,则再加上当前工作目录。 生成的路径已规范化,并且除非将路径解析为根目录,否则将删除尾部斜杠。 零长度的 path 片段会被忽略。 如果没有传入 path 片段,则 path.resolve() 将返回当前工作目录的绝对路径。

        1
        2
        3
        4
        5
        6
        7
        8
        9
        path.resolve('/foo/bar', './baz');
        // 返回: '/foo/bar/baz'

        path.resolve('/foo/bar', '/tmp/file/');
        // 返回: '/tmp/file'

        path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
        // 如果当前工作目录是 /home/myself/node,
        // 则返回 '/home/myself/node/wwwroot/static_files/gif/image.gif'

        如果任何参数不是字符串,则抛出 TypeError

        path.sep

        • <string>

        提供平台特定的路径片段分隔符:

        • Windows 上是 \
        • POSIX 上是 /

        例如,在 POSIX 上:

        1
        2
        'foo/bar/baz'.split(path.sep);
        // 返回: ['foo', 'bar', 'baz']

        在 Windows 上:

        1
        2
        'foo\\bar\\baz'.split(path.sep);
        // 返回: ['foo', 'bar', 'baz']

        在 Windows 上,正斜杠(/)和反斜杠(\)都被接受为路径片段分隔符。 但是, path 方法只添加反斜杠(\)。

        path.toNamespacedPath(path)

        • path <string>
        • 返回: <string>

        仅在 Windows 系统上,返回给定 path 的等效名称空间前缀路径。 如果 path 不是字符串,则将返回 path 而不进行修改。 此方法仅在 Windows 系统上有意义。 在 POSIX 系统上,该方法不可操作,并且始终返回 path 而不进行修改。

        path.win32

        • path.win32 属性提供对特定于 Windows 的 path 方法的实现的访问。

          • 版权声明: 本博客所有文章,未经许可,任何单位及个人不得做营利性使用!转载请标明出处!如有侵权请联系作者。
          • Copyrights © 2015-2020 翟天野

          请我喝杯咖啡吧~