Node.js v18.18.2 文档

Windows 与 POSIX#

node:path模块的默认操作根据运行 Node.js 应用程序的操作系统而有所不同。具体来说，当在 Windows 操作系统上运行时，node:path模块将假定正在使用 Windows 样式的路径。

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

在 POSIX 上：

path.basename('C:\\temp\\myfile.html');
// Returns: 'C:\\temp\\myfile.html' copy

在 Windows 上：

path.basename('C:\\temp\\myfile.html');
// Returns: 'myfile.html' copy

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

在 POSIX 和 Windows 上：

path.win32.basename('C:\\temp\\myfile.html');
// Returns: 'myfile.html' copy

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

在 POSIX 和 Windows 上：

path.posix.basename('/tmp/myfile.html');
// Returns: 'myfile.html' copy

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

path.basename(path[, suffix])#

• path <字符串>
• suffix <string>要删除的可选后缀
• 返回：<字符串>

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

path.basename('/foo/bar/baz/asdf/quux.html');
// Returns: 'quux.html'

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

尽管 Windows 通常以不区分大小写的方式处理文件名（包括文件扩展名），但此函数却不然。例如，C:\\foo.html和 C:\\foo.HTML引用同一个文件，但basename将扩展名视为区分大小写的字符串：

path.win32.basename('C:\\foo.html', '.html');
// Returns: 'foo'

path.win32.basename('C:\\foo.HTML', '.html');
// Returns: 'foo.HTML' copy

如果 path不是字符串，或者给出的suffix不是字符串，则抛出 TypeError。

path.delimiter#

• <字符串>

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

• 适用于 Windows 的;
• :用于 POSIX

例如，在 POSIX 上：

console.log(process.env.PATH);
// Prints: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

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

在 Windows 上：

console.log(process.env.PATH);
// Prints: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

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

path.dirname(path)#

• path <字符串>
• 返回：<字符串>

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

path.dirname('/foo/bar/baz/asdf/quux');
// Returns: '/foo/bar/baz/asdf' copy

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

path.extname(path)#

• path <字符串>
• 返回：<字符串>

path.extname()方法返回path的扩展名，从最后一次出现的. （句点）字符到path最后部分中的字符串末尾。如果path的最后部分中没有. ，或者除了path的基本名称的第一个字符之外，没有.字符（请参阅path.basename()），返回空字符串。

path.extname('index.html');
// Returns: '.html'

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

path.extname('index.');
// Returns: '.'

path.extname('index');
// Returns: ''

path.extname('.index');
// Returns: ''

path.extname('.index.md');
// Returns: '.md' copy

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

path.format(pathObject)#

• pathObject <Object>具有以下属性的任何 JavaScript 对象：
  • dir <字符串>
  • root <字符串>
  • base <字符串>
  • name <字符串>
  • ext <字符串>
• 返回：<字符串>

path.format()方法从对象返回路径字符串。这与path.parse()相反。

向pathObject提供属性时，请记住，在某些组合中，一个属性优先于另一个属性：

• 如果提供了pathObject.dir，则忽略 pathObject.root
• 如果pathObject.base存在，则 pathObject.ext和pathObject.name将被忽略

例如，在 POSIX 上：

// If `dir`, `root` and `base` are provided,
// `${dir}${path.sep}${base}`
// will be returned. `root` is ignored.
path.format({
  root: '/ignored',
  dir: '/home/user/dir',
  base: 'file.txt',
});
// Returns: '/home/user/dir/file.txt'

// `root` will be used if `dir` is not specified.
// If only `root` is provided or `dir` is equal to `root` then the
// platform separator will not be included. `ext` will be ignored.
path.format({
  root: '/',
  base: 'file.txt',
  ext: 'ignored',
});
// Returns: '/file.txt'

// `name` + `ext` will be used if `base` is not specified.
path.format({
  root: '/',
  name: 'file',
  ext: '.txt',
});
// Returns: '/file.txt' copy

在 Windows 上：

path.format({
  dir: 'C:\\path\\dir',
  base: 'file.txt',
});
// Returns: 'C:\\path\\dir\\file.txt' copy

path.isAbsolute(path)#

• path <字符串>
• 返回：<布尔值>

path.isAbsolute()方法确定path是否是绝对路径。

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

例如，在 POSIX 上：

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

在 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 copy

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

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

• ...paths <string>路径段序列
• 返回：<字符串>

path.join()方法使用平台特定的分隔符作为分隔符将所有给定的path段连接在一起，然后规范化结果路径。

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

path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');
// Returns: '/foo/bar/baz/asdf'

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

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

path.normalize(path)#

• path <字符串>
• 返回：<字符串>

path.normalize()方法标准化给定的path，解析'..'和 '.'段。

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

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

例如，在 POSIX 上：

path.normalize('/foo/bar//baz/asdf/quux/..');
// Returns: '/foo/bar/baz/asdf' copy

在 Windows 上：

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// Returns: 'C:\\temp\\foo\\' copy

由于 Windows 可以识别多个路径分隔符，因此两个分隔符都将替换为 Windows 首选分隔符 ( \ ) 的实例：

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
// Returns: 'C:\\temp\\foo\\bar' copy

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

path.parse(path)#

• path <字符串>
• 返回：<对象>

path.parse()方法返回一个对象，其属性代表path的重要元素。尾随目录分隔符将被忽略，请参阅path.sep。

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

• dir <字符串>
• root <字符串>
• base <字符串>
• name <字符串>
• ext <字符串>

例如，在 POSIX 上：

path.parse('/home/user/dir/file.txt');
// Returns:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' } copy

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘
(All spaces in the "" line should be ignored. They are purely for formatting.) copy

在 Windows 上：

path.parse('C:\\path\\dir\\file.txt');
// Returns:
// { root: 'C:\\',
//   dir: 'C:\\path\\dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' } copy

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘
(All spaces in the "" line should be ignored. They are purely for formatting.) copy

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

path.posix#

• <对象>

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

该 API 可通过require('node:path').posix或require('node:path/posix')访问。

path.relative(from, to)#

• from <字符串>
• to <字符串>
• 返回：<字符串>

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

如果零长度字符串作为from或to传递，则将使用当前工作目录而不是零长度字符串。

例如，在 POSIX 上：

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

在 Windows 上：

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

如果 from 或 to 不是字符串，则会抛出{ { {0154} } } 。

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

• ...paths <string>路径或路径段序列
• 返回：<字符串>

path.resolve()方法将一系列路径或路径段解析为绝对路径。

给定的路径序列从右到左处理，每个后续的path都放在前面，直到构造绝对路径。例如，给定路径段的序列：/foo、/bar、baz，调用path.resolve('/foo', '/bar', 'baz')将返回/bar/baz 因为'baz'不是绝对路径，但'/bar' + '/' + 'baz'是。

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

生成的路径将被标准化，并且尾随斜杠将被删除，除非该路径被解析为根目录。

零长度的path段将被忽略。

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

path.resolve('/foo/bar', './baz');
// Returns: '/foo/bar/baz'

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

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// If the current working directory is /home/myself/node,
// this returns '/home/myself/node/wwwroot/static_files/gif/image.gif' copy

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

path.sep#

• <字符串>

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

• Windows 上的\
• POSIX 上的/

例如，在 POSIX 上：

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

在 Windows 上：

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

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

path.toNamespacedPath(path)#

• path <字符串>
• 返回：<字符串>

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

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

path.win32#

• <对象>

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

该 API 可通过require('node:path').win32或require('node:path/win32')访问。