Node.js v26.0.0 文档

Path#

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

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

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

• 类型：<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']
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 <string>
• 返回: <string>

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

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

path.format(pathObject)#

• 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'
copy

在 Windows 上

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

path.matchesGlob(path, pattern)#

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

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

path.isAbsolute(path)#

• 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
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> 一系列路径片段
• 返回: <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 <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'
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 <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' }
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#

• 类型：<Object>

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

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

path.relative(from, to)#

• 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'
copy

在 Windows 上

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

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

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

• ...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'
copy

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

path.sep#

• 类型：<string>

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

• 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 <string>
• 返回: <string>

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

此方法仅在 Windows 系统上有意义。在 POSIX 系统上，该方法无效，且总是返回未经修改的 path。

path.win32#

• 类型：<Object>

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

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