diff --git a/doc/api/path.md b/doc/api/path.md index 49cff7a8beb503..3cbab43c6cc841 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -8,6 +8,9 @@ paths. The file system is not consulted to check whether paths are valid. Use `require('path')` to use this module. The following methods are provided: ## path.basename(path[, ext]) + Return the last portion of a path, similar to the Unix `basename` command. `path` must be a string. `ext`, if given, must also be a string. @@ -23,6 +26,9 @@ path.basename('/foo/bar/baz/asdf/quux.html', '.html') ``` ## path.delimiter + The platform-specific path delimiter, `;` or `':'`. @@ -47,6 +53,9 @@ process.env.PATH.split(path.delimiter) ``` ## path.dirname(path) + Return the directory name of a path, similar to the Unix `dirname` command. `path` must be a string. @@ -59,6 +68,9 @@ path.dirname('/foo/bar/baz/asdf/quux') ``` ## path.extname(path) + Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion @@ -85,6 +97,9 @@ path.extname('.index') ``` ## path.format(pathObject) + Returns a path string from an object. This is the opposite of [`path.parse`][]. @@ -154,6 +169,9 @@ path.format({ ``` ## path.isAbsolute(path) + Determines whether `path` is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. `path` must @@ -182,6 +200,9 @@ path.isAbsolute('.') // false returned. ## path.join([path1][, path2][, ...]) + Join all arguments together and normalize the resulting path. @@ -205,6 +226,9 @@ TypeError: Arguments to path.join must be strings current working directory. ## path.normalize(path) + Normalize a path, taking care of `'..'` and `'.'` parts. `path` must be a string. @@ -224,6 +248,9 @@ path.normalize('/foo/bar//baz/asdf/quux/..') will be returned, which represents the current working directory. ## path.parse(path) + Returns an object from a path. `path` must be a string. @@ -256,11 +283,17 @@ path.parse('C:\\path\\dir\\index.html') ``` ## path.posix + Provide access to aforementioned `path` methods but always interact in a posix compatible way. ## path.relative(from, to) + Solve the relative path from `from` to `to`. `from` and `to` must be strings. @@ -287,6 +320,9 @@ path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb') both the paths are the same then a zero-length string will be returned. ## path.resolve([from ...], to) + Resolves `to` to an absolute path. All arguments must be strings. @@ -331,6 +367,9 @@ path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif') ``` ## path.sep + The platform-specific file separator. `'\\'` or `'/'`. @@ -349,6 +388,9 @@ An example on Windows: ``` ## path.win32 + Provide access to aforementioned `path` methods but always interact in a win32 compatible way.