Path | Node.js v24.0.0 文档

Path#

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

const path = require('node:path');import path from 'node:path';

Windows vs. POSIX#

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

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

在 POSIX 上

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

在 Windows 上

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

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

在 POSIX 和 Windows 上

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

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

在 POSIX 和 Windows 上

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

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

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

历史

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

path <string>
suffix <string> 要删除的可选后缀
返回: <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'

尽管 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'

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

`path.delimiter`#

加入于: v0.9.3

<string>

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

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']

在 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\\']

`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('/foo/bar/baz/asdf/quux');
// Returns: '/foo/bar/baz/asdf'

如果 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');
// 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'

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

`path.format(pathObject)`#

历史

版本	变更
v19.0.0	如果在 `ext` 中未指定，则将添加点。
v0.11.15	加入于: v0.11.15

pathObject <Object> 具有以下属性的任何 JavaScript 对象
- 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 上

// 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'

// The dot will be added if it is not specified in `ext`.
path.format({
  root: '/',
  name: 'file',
  ext: 'txt',
});
// Returns: '/file.txt'

在 Windows 上

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

`path.matchesGlob(path, pattern)`#

加入于: v22.5.0, v20.17.0

稳定性：1 - 实验

path <string> 要与之进行 glob 匹配的路径。
pattern <string> 用于检查路径的 glob。
返回: <boolean> path 是否与 pattern 匹配。

path.matchesGlob() 方法确定 path 是否与 pattern 匹配。

例如

path.matchesGlob('/foo/bar', '/foo/*'); // true
path.matchesGlob('/foo/bar*', 'foo/bird'); // false

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

`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('/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('/foo', 'bar', 'baz/asdf', 'quux', '..');
// Returns: '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar');
// Throws '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 上，此函数应用的规范化类型并不严格遵守 POSIX 规范。例如，此函数将用单个斜杠替换两个前导正斜杠，就像它是常规的绝对路径一样，而某些 POSIX 系统为以两个正斜杠开头的路径赋予特殊含义。类似地，此函数执行的其他替换（例如删除 .. 段）可能会更改底层系统解析路径的方式。

例如，在 POSIX 上

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

在 Windows 上

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

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

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
// Returns: '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('/home/user/dir/file.txt');
// Returns:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

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

在 Windows 上

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

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

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

`path.posix`#

历史

版本	变更
v15.3.0	作为 `require('path/posix')` 暴露。
v0.11.15	加入于: v0.11.15

<Object>

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

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

`path.relative(from, to)`#

历史

版本	变更
v6.8.0	在 Windows 上，UNC 路径的前导斜杠现在包含在返回值中。
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');
// Returns: '../../impl/bbb'

在 Windows 上

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

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

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

添加于: v0.3.4

...paths <string> 路径或路径段的序列
返回: <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'

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

`path.sep`#

添加于: v0.7.9

<string>

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

Windows 上为 \
POSIX 上为 /

例如，在 POSIX 上

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

在 Windows 上

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

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

`path.toNamespacedPath(path)`#

添加于: v9.0.0

path <string>
返回: <string>

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

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

`path.win32`#

历史

版本	变更
v15.3.0	作为 `require('path/win32')` 暴露。
v0.11.15	加入于: v0.11.15

<Object>

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

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

Path#

Windows vs. POSIX#

path.basename(path[, suffix])#

path.delimiter#

path.dirname(path)#

path.extname(path)#

path.format(pathObject)#

path.matchesGlob(path, pattern)#

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

`path.delimiter`#

`path.dirname(path)`#

`path.extname(path)`#

`path.format(pathObject)`#

`path.matchesGlob(path, pattern)`#

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