路径

[稳定版: 2 - 稳定版]

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

CJSESM

const path = require('node:path')

import path from 'node:path'

Windows 与 POSIX

node:path 模块的默认操作取决于运行 Node.js 应用程序的操作系统。具体来说，在 Windows 操作系统上运行时，node: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[, suffix])`

[历史]

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

path <字符串>
suffix <字符串> 可选的后缀，用于移除
返回值: <字符串>

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

path.basename('/foo/bar/baz/asdf/quux.html')
// 返回：'quux.html'

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

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

path.win32.basename('C:\\foo.html', '.html')
// 返回：'foo'

path.win32.basename('C:\\foo.HTML', '.html')
// 返回：'foo.HTML'

如果 path 不是字符串，或者提供了 suffix 但它不是字符串，则会抛出 TypeError 错误。

`path.delimiter`

新增于: v0.9.3

<字符串>

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

； 用于 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 <字符串>
返回: <字符串>

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

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

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

`path.extname(path)`

[历史]

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

path <字符串>
返回值: <字符串>

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

[历史]

版本	变更
v19.0.0	如果 `ext` 中未指定，则会添加点号。
v0.11.15	添加于：v0.11.15

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

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'

// 如果 `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.matchesGlob(path, pattern)`

新增于：v22.5.0, v20.17.0

[稳定性：1 - 实验性]

稳定性：1 稳定性：1 - 实验性

path <字符串> 要进行 glob 匹配的路径。
pattern <字符串> 用于检查路径的 glob 模式。
返回值： <布尔值> 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 <字符串>
返回值： <布尔值>

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('/foo', 'bar', 'baz/asdf', 'quux', '..')
// 返回值: '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// 抛出 '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/..')
// 返回值: '/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 <字符串>
返回值: <对象>

path.parse() 方法返回一个对象，其属性表示 path 的重要组成部分。尾随目录分隔符将被忽略，参见 path.sep。

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

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

例如，在 POSIX 系统上：

path.parse('/home/user/dir/file.txt')
// 返回值:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

text

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘
(请忽略""行中的所有空格，它们仅用于格式化。)

在 Windows 系统上：

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

text

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘
(请忽略""行中的所有空格，它们仅用于格式化。)

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

`path.posix`

[历史]

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

<对象>

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 <字符串>
to <字符串>
返回值: <字符串>

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

Added in: 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')
// 返回: '/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`

新增于: v0.7.9

<字符串>

提供平台相关的路径分隔符：

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 <字符串>
返回: <字符串>

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

此方法仅在 Windows 系统上有意义。在 POSIX 系统上，此方法无效，始终返回未修改的 path。

`path.win32`

[历史]

版本	变更
v15.3.0	作为 `require('path/win32')` 公开。
v0.11.15	在 v0.11.15 中添加

<对象>

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

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

路径 ​

Windows 与 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 ​

路径

Windows 与 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`