path（路径）#

path 模块提供了一些实用工具，用于处理文件和目录的路径。可以使用以下方式访问它：

const path = require('path');

Windows 与 POSIX 的对比#

path 模块的默认操作会因 Node.js 应用程序运行所在的操作系统而异。具体来说，当在 Windows 操作系统上运行时， path 模块会假定正被使用的是 Windows 风格的路径。

因此，使用 path.basename() 可能会在 POSIX 和 Windows 上产生不同的结果：

在 POSIX 上:

path.basename('C:\\temp\\myfile.html');
// 返回: 'C:\\temp\\myfile.html'

在 Windows 上:

path.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'

如果要在任意操作系统上使用 Windows 文件路径时获得一致的结果，则使用 path.win32：

在 POSIX 和 Windows 上:

path.win32.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'

如果要在任意操作系统上使用 POSIX 文件路径时获得一致的结果，则使用 path.posix：

在 POSIX 和 Windows 上:

path.posix.basename('/tmp/myfile.html');
// 返回: 'myfile.html'

在 Windows 上，Node.js 遵循独立驱动器工作目录的概念。当使用没有反斜杠的驱动器路径时，可以观察到此行为。例如， path.resolve('C:\\') 可能会返回与 path.resolve('C:') 不同的结果。详见此 MSDN 页面。

`path.basename(path[, ext])`#

版本历史

版本	变更
v6.0.0	传入非字符串作为 `path` 参数会抛出错误。
v0.1.25	新增于: v0.1.25

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

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

path.basename('/目录1/目录2/文件.html');
// 返回: '文件.html'

path.basename('/目录1/目录2/文件.html', '.html');
// 返回: '文件'

尽管 Windows 通常以不区分大小写的方式处理文件名（包括文件扩展名），但是此函数不会这样。例如， C:\\文件.html 和 C:\\文件.HTML 指向相同的文件，但是 basename 会将扩展名视为区分大小写的字符串：

path.win32.basename('C:\\文件.html', '.html');
// 返回: '文件'

path.win32.basename('C:\\文件.HTML', '.html');
// 返回: '文件.HTML'

如果 path 不是字符串、或给定了 ext 但不是字符串，则抛出 TypeError。

`path.delimiter`#

新增于: v0.9.3

<string>

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

; 用于 Windows
: 用于 POSIX

例如，在 POSIX 上：

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 上：

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)`#

版本历史

版本	变更
v6.0.0	传入非字符串作为 `path` 参数会抛出错误。
v0.1.16	新增于: v0.1.16

path <string>
返回: <string>

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

path.dirname('/目录1/目录2/目录3');
// 返回: '/目录1/目录2'

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

`path.extname(path)`#

版本历史

版本	变更
v6.0.0	传入非字符串作为 `path` 参数会抛出错误。
v0.1.25	新增于: v0.1.25

path <string>
返回: <string>

path.extname() 方法会返回 path 的扩展名，即 path 的最后一部分中从最后一次出现 .（句点）字符直到字符串结束。如果在 path 的最后一部分中没有 .，或者如果 path 的基本名称（参见 path.basename()）除了第一个字符以外没有 .，则返回空字符串。

path.extname('index.html');
// 返回: '.html'

path.extname('index.coffee.md');
// 返回: '.md'

path.extname('index.');
// 返回: '.'

path.extname('index');
// 返回: ''

path.extname('.index');
// 返回: ''

path.extname('.index.md');
// 返回: '.md'

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

`path.format(pathObject)`#

新增于: v0.11.15

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'

`path.isAbsolute(path)`#

新增于: v0.11.2

path <string>
返回: <boolean>

path.isAbsolute() 方法检测 path 是否为绝对路径。

如果给定的 path 是零长度字符串，则返回 false。

例如，在 POSIX 上：

path.isAbsolute('/foo/bar'); // true
path.isAbsolute('/baz/..');  // true
path.isAbsolute('qux/');     // false
path.isAbsolute('.');        // false

在 Windows 上：

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])`#

新增于: v0.1.16

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

path.join() 方法会将所有给定的 path 片段连接到一起（使用平台特定的分隔符作为定界符），然后规范化生成的路径。

长度为零的 path 片段会被忽略。如果连接后的路径字符串为长度为零的字符串，则返回 '.'，表示当前工作目录。

path.join('/目录1', '目录2', '目录3/目录4', '目录5', '..');
// 返回: '/目录1/目录2/目录3/目录4'

path.join('目录1', {}, '目录2');
// 抛出 'TypeError: Path must be a string. Received {}'

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

`path.normalize(path)`#

新增于: v0.1.23

path <string>
返回: <string>

path.normalize() 方法规范化给定的 path，解析 '..' 和 '.' 片段。

当找到多个连续的路径段分隔字符时（例如 POSIX 上的 /、Windows 上的 \ 或 /），则它们将被替换为单个平台特定的路径段分隔符（POSIX 上的 /、Windows 上的 \）。尾部的分隔符会保留。

如果 path 是零长度的字符串，则返回 '.'，表示当前工作目录。

例如，在 POSIX 上：

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

在 Windows 上：

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// 返回: 'C:\\temp\\foo\\'

由于 Windows 识别多种路径分隔符，因此这些分隔符都将被替换为 Windows 首选的分隔符（\）：

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
// 返回: 'C:\\temp\\foo\\bar'

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

`path.parse(path)`#

新增于: v0.11.15

path <string>
返回: <Object>

path.parse() 方法会返回一个对象，其属性表示 path 的有效元素。尾部的目录分隔符会被忽略，参见 path.sep。

返回的对象具有以下属性：

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

例如，在 POSIX 上：

path.parse('/目录1/目录2/文件.txt');
// 返回:
// { root: '/',
//   dir: '/目录1/目录2',
//   base: '文件.txt',
//   ext: '.txt',
//   name: '文件' }

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    目录1/目录2    / 文件   .txt "
└──────┴──────────────┴──────┴─────┘
（"" 行中的所有空格均可忽略。它们纯粹是用于格式化。）

在 Windows 上：

path.parse('C:\\目录1\\目录2\\文件.txt');
// 返回:
// { root: 'C:\\',
//   dir: 'C:\\目录1\\目录2',
//   base: '文件.txt',
//   ext: '.txt',
//   name: '文件' }

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\    目录1\目录2   \ 文件   .txt "
└──────┴──────────────┴──────┴─────┘
（"" 行中的所有空格均可忽略。它们纯粹是用于格式化。）

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

`path.posix`#

新增于: v0.11.15

<Object>

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

`path.relative(from, to)`#

版本历史

版本	变更
v6.8.0	On Windows, the leading slashes for UNC paths are now included in the return value.
v0.5.0	新增于: v0.5.0

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

path.relative() 方法根据当前工作目录返回 from 到 to 的相对路径。如果 from 和 to 各自解析到相同的路径（分别调用 path.resolve() 之后），则返回零长度的字符串。

如果将零长度的字符串传入 from 或 to，则使用当前工作目录代替该零长度的字符串。

例如，在 POSIX 上：

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

在 Windows 上：

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

如果 from 或 to 不是字符串，则抛出 TypeError。

`path.resolve([...paths])`#

新增于: v0.3.4

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

path.resolve() 方法会将路径或路径片段的序列解析为绝对路径。

给定的路径序列会从右到左进行处理，后面的每个 path 会被追加到前面，直到构造出绝对路径。例如，给定的路径片段序列：/目录1、 /目录2、 目录3，调用 path.resolve('/目录1', '/目录2', '目录3') 会返回 /目录2/目录3，因为 '目录3' 不是绝对路径，但 '/目录2' + '/' + '目录3' 是。

如果在处理完所有给定的 path 片段之后还未生成绝对路径，则会使用当前工作目录。

生成的路径会被规范化，并且尾部的斜杠会被删除（除非路径被解析为根目录）。

零长度的 path 片段会被忽略。

如果没有传入 path 片段，则 path.resolve() 会返回当前工作目录的绝对路径。

path.resolve('/目录1/目录2', './目录3');
// 返回: '/目录1/目录2/目录3'

path.resolve('/目录1/目录2', '/目录3/目录4/');
// 返回: '/目录3/目录4'

path.resolve('目录1', '目录2/目录3/', '../目录4/文件.gif');
// 如果当前工作目录是 /目录A/目录B，
// 则返回 '/目录A/目录B/目录1/目录2/目录4/文件.gif'

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

`path.sep`#

新增于: v0.7.9

<string>

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

Windows 上是 \。
POSIX 上是 /。

例如，在 POSIX 上：

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

在 Windows 上：

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

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

`path.toNamespacedPath(path)`#

新增于: v9.0.0

path <string>
返回: <string>

仅在 Windows 系统上，返回给定 path 的等效名称空间前缀路径。如果 path 不是字符串，则将返回 path 而不进行修改。

此方法仅在 Windows 系统上有意义。在 POSIX 系统上，该方法不可操作，并且始终返回 path 而不进行修改。

`path.win32`#

新增于: v0.11.15

<Object>

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

目录

path（路径）#

Windows 与 POSIX 的对比#

path.basename(path[, ext])#

path.delimiter#

path.dirname(path)#

path.extname(path)#

path.format(pathObject)#

path.isAbsolute(path)#

path.join([...paths])#

path.normalize(path)#

path.parse(path)#

path.posix#

path.relative(from, to)#

path.resolve([...paths])#

path.sep#

path.toNamespacedPath(path)#

path.win32#

`path.basename(path[, ext])`#

`path.delimiter`#

`path.dirname(path)`#

`path.extname(path)`#

`path.format(pathObject)`#

`path.isAbsolute(path)`#

`path.join([...paths])`#

`path.normalize(path)`#

`path.parse(path)`#

`path.posix`#

`path.relative(from, to)`#

`path.resolve([...paths])`#

`path.sep`#

`path.toNamespacedPath(path)`#

`path.win32`#