Node.js v10.13.0 文档


path - 路径#

中英对照

稳定性: 2 - 稳定的

path 模块用于处理文件与目录的路径。使用方法:

const path = require('path');

Windows 与 POSIX#

中英对照

path 模块会因操作系统的差异而不同。 比如在 Windows 上,path 模块会认为使用的是 Windows 风格的路径。

例如,对文件路径 C:\temp\myfile.html 使用 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'

path.basename(path[, ext])#

中英对照

返回 path 的最后一部分,类似于 Unix 中的 basename 命令。

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

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

path.delimiter#

中英对照

返回平台特定的路径分隔符:

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

中英对照

返回 path 的目录名,类似于 Unix 中的 dirname 命令。

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

path.extname(path)#

中英对照

返回 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.format(pathObject)#

中英对照

将一个对象格式化为一个路径字符串。 与 path.parse() 相反。

pathObject 的属性有不同的优先级:

  • 如果指定了 pathObject.dir,则忽略 pathObject.root
  • 如果指定了 pathObject.base,则忽略 pathObject.extpathObject.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)#

中英对照

判断 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.join([...paths])#

中英对照

使用平台特定的分隔符把所有 path 片段连接到一起,并规范化生成的路径。

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

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

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

path.normalize(path)#

中英对照

规范化指定的 path,并处理 '..''.' 片段。

当出现多个连续的路径分隔符时(如 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 上出现多种路径分隔符,则都使用 \ 替换:

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

path.parse(path)#

中英对照

返回一个对象,其中对象的属性表示 path 的元素。

返回的对象有以下属性:

例如,在 POSIX 上:

path.parse('/home/user/dir/file.txt');
// 返回:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }
┌─────────────────────┬────────────┐
│          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' }
┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘

path.posix#

中英对照

返回为 POSIX 实现的 path 方法。

path.relative(from, to)#

中英对照

返回从 fromto 的相对路径(基于当前工作目录)。 如果 fromto 解析到同一路径(调用 path.resolve()),则返回一个长度为零的字符串。

如果 fromto 传入长度为零的字符串,则使用当前工作目录代替长度为零的字符串。

例如,在 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'

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

中英对照

将路径或路径片段的序列处理成绝对路径。

指定的路径序列是从右往左开始处理的,后面的 path 被依次处理,直到构造完绝对路径。 例如,指定的路径片段序列为:/foo/barbaz,则调用 path.resolve('/foo', '/bar', 'baz') 会返回 /bar/baz

如果处理完所有 path 片段后还未生成绝对路径,则使用当前工作目录。

生成的路径是规范化后的,且末尾的斜杠会被删除,除非路径是根目录。

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

如果没有传入 path 片段,则返回当前工作目录的绝对路径。

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

path.sep#

中英对照

返回平台特定的路径片段分隔符:

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

中英对照

返回 path带命名空间前缀的路径,仅支持 Window 系统。

path.win32#

中英对照

返回为 Windows 实现的 path 方法。