{ "source": "path.markdown", "modules": [ { "textRaw": "路径 (Path)", "name": "路径_(path)", "desc": "
稳定度: 3 - 稳定
\n

This module contains utilities for handling and transforming file\npaths. Almost all these methods perform only string transformations.\nThe file system is not consulted to check whether paths are valid.\n\n

\n

本模块包含一套用于处理和转换文件路径的工具集。几乎所有的方法仅对字符串进行转换，\n文件系统是不会检查路径是否真实有效的。\n\n

\n

Use require('path') to use this module. The following methods are provided:\n\n

\n

通过 require('path') 来加载此模块。以下是本模块所提供的方法：\n\n

\n", "methods": [ { "textRaw": "path.normalize(p)", "type": "method", "name": "normalize", "desc": "

Normalize a string path, taking care of '..' and '.' parts.\n\n

\n

规范化字符串路径，注意 '..' 和 `'.' 部分\n\n

\n

When multiple slashes are found, they're replaced by a single one;\nwhen the path contains a trailing slash, it is preserved.\nOn Windows backslashes are used.\n\n

\n

当发现有多个连续的斜杠时，会替换成一个；\n当路径末尾包含斜杠时，会保留；\n在 Windows 系统会使用反斜杠。\n\n

\n

Example:\n\n

\n

示例：\n\n

\n
path.normalize('/foo/bar//baz/asdf/quux/..')\n// returns\n'/foo/bar/baz/asdf'
\n", "signatures": [ { "params": [ { "name": "p" } ] } ] }, { "textRaw": "path.join([path1], [path2], [...])", "type": "method", "name": "join", "desc": "

Join all arguments together and normalize the resulting path.\n\n

\n

组合参数中的所有路径，返回规范化后的路径。\n\n

\n

Arguments must be strings. In v0.8, non-string arguments were\nsilently ignored. In v0.10 and up, an exception is thrown.\n\n

\n

参数必须是字符串。在 v0.8 版本非字符串参数会被悄悄忽略。\n在 v0.10 及以后版本将会抛出一个异常。\n\n

\n

Example:\n\n

\n

示例：\n\n

\n
path.join('foo', {}, 'bar')\n// 抛出异常\nTypeError: Arguments to path.join must be strings
\n", "signatures": [ { "params": [ { "name": "path1", "optional": true }, { "name": "path2", "optional": true }, { "name": "...", "optional": true } ] } ] }, { "textRaw": "path.resolve([from ...], to)", "type": "method", "name": "resolve", "desc": "

Resolves to to an absolute path.\n\n

\n

将 to 参数解析为一个绝对路径。\n\n

\n

If to isn't already absolute from arguments are prepended in right to left\norder, until an absolute path is found. If after using all from paths still\nno absolute path is found, the current working directory is used as well. The\nresulting path is normalized, and trailing slashes are removed unless the path\ngets resolved to the root directory. Non-string arguments are ignored.\n\n

\n

如果to不是一个相对于from 参数的绝对路径，to会被添加到from的右边，直到找出一个绝对路径为止。如果使用from路径且仍没有找到绝对路径时，使用当时路径作为目录。返回的结果已经规范化，得到的路径会去掉结尾的斜杠，除非得到的当前路径为root目录。非字符串参数将被忽略。\n\n

\n

Another way to think of it is as a sequence of cd commands in a shell.\n\n

\n

另一种思考方式就是像在shell里面用一系列的‘cd’命令一样.\n\n

\n
path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')
\n

Is similar to:\n\n

\n

相当于:\n\n

\n
cd foo/bar\ncd /tmp/file/\ncd ..\ncd a/../subfile\npwd
\n

The difference is that the different paths don't need to exist and may also be\nfiles.\n\n

\n

不同的是，不同的路径不需要存在的，也可能是文件。\n\n

\n

Examples:\n\n

\n

示例:\n\n

\n
path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')\n// 如果当前工作目录为 /home/myself/node，它返回：\n'/home/myself/node/wwwroot/static_files/gif/image.gif'
\n", "signatures": [ { "params": [ { "name": "from ...", "optional": true }, { "name": "to" } ] } ] }, { "textRaw": "path.isAbsolute(path)", "type": "method", "name": "isAbsolute", "desc": "

Determines whether path is an absolute path. An absolute path will always\nresolve to the same location, regardless of the working directory.\n\n

\n

判定path是否为绝对路径。一个绝对路径总是指向一个相同的位置，无论当前工作目录是在哪里。\n\n

\n

Posix examples:\n\n

\n

Posix 示例:\n\n

\n
path.isAbsolute('/foo/bar') // true\npath.isAbsolute('/baz/..')  // true\npath.isAbsolute('qux/')     // false\npath.isAbsolute('.')        // false
\n

Windows examples:\n\n

\n

Windows 示例:\n\n

\n
path.isAbsolute('//server')  // true\npath.isAbsolute('C:/foo/..') // true\npath.isAbsolute('bar\\\\baz')   // false\npath.isAbsolute('.')         // false
\n", "signatures": [ { "params": [ { "name": "path" } ] } ] }, { "textRaw": "path.relative(from, to)", "type": "method", "name": "relative", "desc": "

Solve the relative path from from to to.\n\n

\n

解决从from到to的相对路径。\n\n

\n

At times we have two absolute paths, and we need to derive the relative\npath from one to the other. This is actually the reverse transform of\npath.resolve, which means we see that:\n\n

\n

有时我们有2个绝对路径, 我们需要从中找出相对目录的起源目录。这完全是path.resolve的相反实现,我们可以看看是什么意思:\n\n

\n
path.resolve(from, path.relative(from, to)) == path.resolve(to)
\n

Examples:\n\n

\n

示例:\n\n

\n
path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')\n// 返回\n'../../impl/bbb'
\n", "signatures": [ { "params": [ { "name": "from" }, { "name": "to" } ] } ] }, { "textRaw": "path.dirname(p)", "type": "method", "name": "dirname", "desc": "

Return the directory name of a path. Similar to the Unix dirname command.\n\n

\n

返回路径中文件夹的名称. 类似于Unix的dirname 命令.\n\n

\n

Example:\n\n

\n

示例：\n\n

\n
path.dirname('/foo/bar/baz/asdf/quux')\n// returns\n'/foo/bar/baz/asdf'
\n", "signatures": [ { "params": [ { "name": "p" } ] } ] }, { "textRaw": "path.basename(p, [ext])", "type": "method", "name": "basename", "desc": "

Return the last portion of a path. Similar to the Unix basename command.\n\n

\n

返回路径中的最后哦一部分. 类似于Unix 的 basename 命令.\n\n

\n

Example:\n\n

\n

示例：\n\n

\n
path.basename('/foo/bar/baz/asdf/quux.html', '.html')\n// returns\n'quux'
\n", "signatures": [ { "params": [ { "name": "p" }, { "name": "ext", "optional": true } ] } ] }, { "textRaw": "path.extname(p)", "type": "method", "name": "extname", "desc": "

Return the extension of the path, from the last '.' to end of string\nin the last portion of the path. If there is no '.' in the last portion\nof the path or the first character of it is '.', then it returns\nan empty string. Examples:\n\n

\n

返回路径中文件的扩展名, 在从最后一部分中的最后一个'.'到字符串的末尾。\n如果在路径的最后一部分没有'.'，或者第一个字符是'.'，就返回一个\n空字符串。 例子：\n\n

\n
path.extname('index')\n// returns\n''
\n", "signatures": [ { "params": [ { "name": "p" } ] } ] } ], "properties": [ { "textRaw": "path.sep", "name": "sep", "desc": "

The platform-specific file separator. '\\\\' or '/'.\n\n

\n

特定平台的文件分隔工具. '\\\\' 或者 '/'.\n\n

\n

An example on *nix:\n\n

\n

*nix 上的例子:\n\n

\n
'foo/bar/baz'.split(path.sep)\n// returns\n['foo', 'bar', 'baz']
\n

An example on Windows:\n\n

\n

Windows 上的例子:\n\n

\n
'foo\\\\bar\\\\baz'.split(path.sep)\n// returns\n['foo', 'bar', 'baz']
\n" }, { "textRaw": "path.delimiter", "name": "delimiter", "desc": "

The platform-specific path delimiter, ; or ':'.\n\n

\n

特定平台的路径分隔符, ; 或者 ':'.\n\n

\n

An example on *nix:\n\n

\n

*nix 上的例子:\n\n

\n
process.env.PATH.split(path.delimiter)\n// returns\n['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']
\n

An example on Windows:\n\n

\n

Windows 上的例子:\n\n

\n
console.log(process.env.PATH)\n// 'C:\\Windows\\system32;C:\\Windows;C:\\Program Files\\nodejs\\'\n\nprocess.env.PATH.split(path.delimiter)\n// returns\n['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\nodejs\\']\n\n\nprocess.env.PATH.split(path.delimiter)\n// returns\n['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\nodejs\\']
\n" } ], "type": "module", "displayName": "路径 (Path)" } ] }