node常用模块之path

path(路径)

path模块提供了一些工具函数,用于处理文件与目录的路径。可以通过以下方式使用:

const path = require('path');

path.basename(path[, ext])

  • path <String>
  • ext <String> 可选的文件扩展名
  • 返回:<String>

path.basename()方法返回一个path的最后一部分,类似于Unix中的basename命令。

例子:

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

如果path不是一个字符串或提供了ext但不是一个字符串,则抛出TypeError。

path.delimiter

  • <String>

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

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

path.dirname()方法返回一个path的目录名,类似于Unix中的dirname命令。

例子:

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

如果path不是一个字符串,则抛出TypeError。

path.extname(path)

  • path <String>
  • 返回:<String>

path.extname()方法返回path的扩展名,即从path的最后一部分中的最后一个.字符到字符串结束。如果path的最后一部分没有.path的文件名的第一个字符是.,则返回一个空字符串。

例子:

path.extname('index.html'); // 返回:‘.html’
path.extname('index.coffee.md'); // 返回:‘.md’
path.extname('index.'); // 返回: ‘.’
path.extname('index'); // 返回:‘’
path.extname('.index'); // 返回:‘’

如果path不是一个字符串,则抛出TypeError。

path.format(pathObject)

  • pathObject <Object>
    • dir <String>
    • root <String>
    • base <String>
    • name <String>
    • ext <String>
  • 返回:<String>

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

parhObject提供的属性有组合时,有些属性的优先级比其他的高:

  • 如果提供了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: '/',
  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>
  • 返回:<String>

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

  • ...paths <String> 一个路径片段的序列
  • 返回:<String>

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

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

例子:

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

path.join('foo', {}, 'bar')
// 抛出 TypeError: path.join 的参数必须为字符串

如果任一路径片段不是一个字符串,则抛出 TypeError。

path.normalize(path)

  • path <String>
  • 返回:<String>

path.normalize() 方法会规范化给定的 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\\'

如果 path不是一个字符串,则抛出 TypeError。

path.parse(path)

  • path <String>
  • 返回:<Object>

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

返回的对象有以下属性:

  • root <String>
  • dir <String>
  • base <String>
  • ext <String>
  • name <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 不是一个字符串,则抛出TypeError。

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')
// 返回: '../../impl/bbb'

在 Windows 上:

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

如果 from 或 to 不是一个字符串,则抛出 TypeError。

path.resolve([...paths])

  • ...paths <String> 一个路径或路径片段的序列
  • 返回:<String>

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

给定的路径的序列是从右往左被处理的,后面每个 path 被依次解析,直到构造完成一个绝对路径。 例如,给定的路径片段的序列为:/foo、/bar、baz,则调用 path.resolve('/foo', '/bar', '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

  • <String>

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

  • Windows 上是 \
  • POSIX 上是 /

例如,在 POSIX 上:

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

在 Windows 上:

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

path.win32

  • <Object>

path.win32属性提供了path 方法针对 Windows 的实现。

注意:在 Windows 上,斜杠字符(/)和反斜杠字符(\)都可作为路径分隔符; 但返回值中只用到反斜杠(\)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,509评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,806评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,875评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,441评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,488评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,365评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,190评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,062评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,500评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,706评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,834评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,559评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,167评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,779评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,912评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,958评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,779评论 2 354

推荐阅读更多精彩内容