path模块

发表于 | 分类于 | 阅读次数

path.basename(path[,ext])

语法：

path.basename(path[,ext])

path:路径 例：/Users/melody0z/github/nodejs/second/a.txt

ext: 扩展名 （extension) 例：.txt

返回一个path的最后一部分，也就是文件名。

1
2
3
4
5
path.basename("/Users/melody0z/github/nodejs/second/a.txt")
//  a.txt
path.basename("/Users/melody0z/github/nodejs/second/a.txt",".txt");
//   a

path.delimiter

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

  • windows上是;
  • POSIX上是:
1
2
3
4
5
console.log(process.env.PATH);
//   /usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
console.log(process.env.PATH.split(path.delimiter));
//   [ '/usr/local/bin', '/usr/bin', '/bin', '/usr/sbin', '/sbin' ]

path.dirname(path)

语法：

path.dirname(path)

path: 路径 例如：/Users/melody0z/github/nodejs/second/a.txt

返回一个path的目录名

1
2
path.dirname("/Users/melody0z/github/nodejs/second/a.txt")
//  /Users/melody0z/github/nodejs/second

path.extname(path)

语法：

path.extname(path)

path: 路径 例如：/Users/melody0z/github/nodejs/second/a.txt

返回path的扩展名，即从 path 的最后一部分中的最后一个 .（句号）字符到字符串结束。 如果 path 的最后一部分没有 . 或 path 的文件名（见 path.basename()）的第一个字符是 .，则返回一个空字符串。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
path.extname('index.html');
// 返回: '.html'
path.extname('index.coffee.md');
// 返回: '.md'
path.extname('index.');
// 返回: '.'
path.extname('index');
// 返回: ''
path.extname('.index');
// 返回: ''

path.parse(path)

语法：

path.parse(path)

path.parse() 方法返回一个对象，对象的属性表示 path 的元素。

返回的对象有以下属性：

  • dir
  • root
  • base
  • name
  • ext

在POSIX上：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 上：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.format(pathObject)

  • pathObject
    • dir
    • root
    • base
    • name
    • ext

返回一个path字符串

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

当 pathObject 提供的属性有组合时，有些属性的优先级比其他的高：

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

例如，在 POSIX 上：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// 如果提供了 `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 上：

1
2
3
4
5
path.format({
  dir: 'C:\\path\\dir',
  base: 'file.txt'
});
// 返回: 'C:\\path\\dir\\file.txt'

path.isAbsolute(path)

path: 路径

返回一个布尔值

path.isAbsolute() 方法会判定 path 是否为一个绝对路径。

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

例如，在 POSIX 上：

1
2
3
4
path.isAbsolute('/foo/bar'); // true
path.isAbsolute('/baz/..');  // true
path.isAbsolute('qux/');     // false
path.isAbsolute('.');        // false

在 Windows 上：

1
2
3
4
5
6
7
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])

…pahts 一个路径片段的序列

返回一个完整路径字符串

path.join() 方法使用平台特定的分隔符把全部给定的 path 片段连接到一起，并规范化生成的路径。

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

例子：

1
2
3
4
5
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: 路径

返回一个正常版的路径字符串

path.normalize() 方法会规范化给定的 path，并解析 '..' 和 '.' 片段。

当发现多个连续的路径分隔符时（如 POSIX 上的 / 与 Windows 上的 \ 或 /），它们会被单个的路径分隔符（POSIX 上是 /，Windows 上是 \）替换。 末尾的多个分隔符会被保留。

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

例如，在 POSIX 上：

1
2
path.normalize('/foo/bar//baz/asdf/quux/..');
// 返回: '/foo/bar/baz/asdf'

在 Windows 上：

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

path.relative(from,to)

path.relative() 方法返回从 from 到 to 的相对路径（基于当前工作目录）。 如果 from 和 to 各自解析到同一路径（调用 path.resolve()），则返回一个长度为零的字符串。

如果 from 或 to 传入了一个长度为零的字符串，则当前工作目录会被用于代替长度为零的字符串。

例如，在 POSIX 上：

1
2
path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
// 返回: '../../impl/bbb'

在 Windows 上：

1
2
path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
// 返回: '..\\..\\impl\\bbb'

path.resolve([…paths])

…paths 一个路径或路径片段的序列

返回一个绝对路径

path.resolve() 方法会把一个路径或路径片段的序列解析为一个绝对路径。

给定的路径的序列是从右往左被处理的，后面每个 path 被依次解析，直到构造完成一个绝对路径。 例如，给定的路径片段的序列为：/foo、/bar、baz，则调用 path.resolve('/foo', '/bar', 'baz') 会返回 /bar/baz。

如果处理完全部给定的 path 片段后还未生成一个绝对路径，则当前工作目录会被用上。

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

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

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

例子：

1
2
3
4
5
6
7
8
9
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 上：

1
2
'foo/bar/baz'.split(path.sep);
// 返回: ['foo', 'bar', 'baz']

在 Windows 上：

1
2
'foo\\bar\\baz'.split(path.sep);
// 返回: ['foo', 'bar', 'baz']

注意：在 Windows 上，斜杠字符（/）和反斜杠字符（\）都可作为路径分隔符； 但 path 的方法只添加反斜杠（\）。

本文结束，感谢阅读。

参考资料：node官方文档

本文作者：melody0z
本文链接：https://melodyvoid/Node/path-module.html
欢迎转载，转载请注明文本链接

坚持原创技术分享，您的支持将鼓励我继续创作！