这是一篇读Nodejs API的读书笔记(抄书笔记)
path模块
小总结:
ext 扩展名
base 文件全名
dir 路径名(不包括文件名)
delimiter 分隔符
root 你懂的
----------------------------------------
path 路径 用win32、posix
path.basename(path[, ext])
返回最后一部分如index.html, ext为扩展名,加了后就不返回扩展名
path.delimiter 是分割符 ; 或 : 用split分割
path.sep 路径分隔符 win: \, POSIX: /
path.dirname(path) 返回目录名,不包括当前
path.extname(path) 返回文件扩展名
path.format(pathObject) 把dir、root、base、name、ext组合,有优先级
path.isAbsolute(path) 判断是否为绝对路径
path.join([...paths]) 组合路径
path.normalize(path) 规范化路径
path.parse(path) 和format 相反 返回对象dir、root、base、name、ext
path.relative(from, to) from到to的相对路径,无参数有区别
path.resolve([...paths]) 把片段路径解析为绝对路径,无参数返回当前
path(路径)
path是nodejs的模块,提供了一些工具函数,用于处理文件与目录的路径
使用方法
const path = require('path')
path模块在windows与POSIX环境下的不同
path模块的默认操作会因为node运行环境的不同而变化
在POSIX上
path.basename('C:\\temp\\myfile.html');
// 返回: 'C:\\temp\\myfile.html'
在 Windows 上:
path.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'
处理windows文件路径
path.win32.basename('C:\\temp\\myfile.html');
// 返回: 'myfile.html'
处理POSIX文件路径
path.posix.basename('/tmp/myfile.html');
// 返回: 'myfile.html'
POSIX是UNIX的一套可移植性标准
path.basename(path[, ext])
- path
<string>
- ext
<string>
可选 - 返回
<string>
path.basename() 方法返回一个 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
path.delimiter是分隔符,windows上是;
,POSIX是:
在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\\']
在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上给路径分割了数组](http://upload-images.jianshu.io/upload_images/2155778-6fc1dbe9cd8917cf.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
path.dirname(path)
- path
<string>
不是字符串就报错
path.dirname() 方法返回一个 path 的目录名,类似于 Unix 中的 dirname 命令。
path.dirname('/foo/bar/baz/asdf/quux')
// 返回: '/foo/bar/baz/asdf'
path.extname(path)
- path
<string>
非字符串报错 - return
<string>
返回path的扩展名,有.
就返回.
,没有就返回空
path.format(pathObject)
- pathObject
<object>
- dir
<string>
- root
<string>
- base
<string>
- name
<string>
- ext
<string>
- dir
- return
<string>
path.format()方法会从一个对象返回一个路径字符串。 与 path.parse()
相反。
当 pathObject 提供的属性有组合时,有些属性的优先级比其他的高:
在 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
<string>
- return
<boolean>
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.join([...paths])
-
...paths
一个路径片段的序列
path.join() 方法使用平台特定的分隔符把全部给定的 path 片段连接到一起,并规范化生成的路径。
长度为零的 path 片段会被忽略。 如果连接后的路径字符串是一个长度为零的字符串,则返回 '.',表示当前工作目录。
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// 返回: '/foo/bar/baz/asdf' 这里的`..`表示上一层
path.join('foo', {}, 'bar')
// 抛出 TypeError: path.join 的参数必须为字符串
path.normalize(path)
path.normalize() 方法会规范化给定的 path,并解析 '..' 和 '.' 片段。
当发现多个连续的路径分隔符时(如 POSIX 上的 / 与 Windows 上的 \),它们会被单一的路径分隔符替换。 末尾的多个分隔符会被保留。
例如,在 POSIX 上:
path.normalize('/foo/bar//baz/asdf/quux/..')
// 返回: '/foo/bar/baz/asdf'
在 Windows 上:
path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// 返回: 'C:\\temp\\foo\\'
path.parse(path) 和format 相反
path.parse() 方法返回一个对象,对象的属性表示 path 的元素。
返回的对象有以下属性:
- dir
<string>
- root
<string>
- base
<string>
- name
<string>
- ext
<string>
例如,在 POSIX 上:
path.parse('/home/user/dir/file.txt')
// 返回:
// {
// root : "/",
// dir : "/home/user/dir",
// base : "file.txt",
// ext : ".txt",
// name : "file"
// }
在 Windows 上:
path.parse('C:\\path\\dir\\file.txt')
// 返回:
// {
// root : "C:\\",
// dir : "C:\\path\\dir",
// base : "file.txt",
// ext : ".txt",
// name : "file"
// }
path.posix (开头讲的)
path.posix 属性提供了 path 方法针对 POSIX 的实现。
path.relative(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'
to为0就到当前,from为0就直接到to
path.resolve([...paths])
path.resolve() 方法会把一个路径或路径片段的序列解析为一个绝对路径。
则 path.resolve() 会返回当前工作目录的绝对路径。
如果没有传入 path 片段,则 path.resolve() 会返回当前工作目录的绝对路径。
path.sep
提供了平台特定的路径片段分隔符:
Windows 上是 , POSIX 上是`/
在 POSIX 上:
'foo/bar/baz'.split(path.sep)
// 返回: ['foo', 'bar', 'baz']
在 Windows 上:
'foo\\bar\\baz'.split(path.sep)
// 返回: ['foo', 'bar', 'baz']
path.win32
path.win32 属性提供了 path 方法针对 Windows 的实现。
注意:在 Windows 上,斜杠字符(/)和反斜杠字符(\)都可作为路径分隔符; 但返回值中只用到反斜杠(\)。