Namespace node.path
This module contains utilities for dealing with file paths. Use
require('path')
to use it. It provides the following methods:
- Defined in: node.path.js
Method Summary
Method Attributes | Method Name and Description |
---|---|
static |
node.path.basename(path, ext)
Return the last portion of a path.
|
static |
node.path.dirname(path)
Return the directory name of a path.
|
static |
node.path.exists(path, callback)
Test whether or not the given path exists.
|
static |
node.path.existsSync(path)
Synchronous version of
path.exists . |
static |
node.path.extname(path)
Return the extension of the path.
|
static |
node.path.join()
Join all arguments together and normalize the resulting path.
|
static |
node.path.normalize(path)
Normalize a string path, taking care of
'. |
static |
node.path.resolve(var_args)
Resolves
to to an absolute path. |
Method Detail
-
static node.path.basename(path, ext)Return the last portion of a path. Similar to the Unix
basename
command. Example:path.basename('/foo/bar/baz/asdf/quux.html') // returns 'quux.html' path.basename('/foo/bar/baz/asdf/quux.html', '.html') // returns 'quux'
- Parameters:
- {string} path
- {string} ext
-
static node.path.dirname(path)Return the directory name of a path. Similar to the Unix
dirname
command. Example:path.dirname('/foo/bar/baz/asdf/quux') // returns '/foo/bar/baz/asdf'
- Parameters:
- {string} path
-
static node.path.exists(path, callback)Test whether or not the given path exists. Then, call the
callback
argument with either true or false. Example:path.exists('/etc/passwd', function (exists) { util.debug(exists ? "it's there" : "no passwd!"); });
- Parameters:
- {string} path
- {function(Error?|...[*]):undefined=} callback
-
static node.path.existsSync(path)Synchronous version of
path.exists
.- Parameters:
- {string} path
-
static node.path.extname(path)Return the extension of the path. Everything after the last '.' in the last portion of the path. If there is no '.' in the last portion of the path or the only '.' is the first character, then it returns an empty string. Examples:
path.extname('index.html') // returns '.html' path.extname('index') // returns ''
- Parameters:
- {string} path
-
static node.path.join()Join all arguments together and normalize the resulting path. Example:
node> require('path').join( ... '/foo', 'bar', 'baz/asdf', 'quux', '..') '/foo/bar/baz/asdf'
-
static node.path.normalize(path)Normalize a string path, taking care of
'..'
and'.'
parts. When multiple slashes are found, they're replaces by a single one; when the path contains a trailing slash, it is preserved. On windows backslashes are used. Example:path.normalize('/foo/bar//baz/asdf/quux/..') // returns '/foo/bar/baz/asdf'
- Parameters:
- {string} path
-
static node.path.resolve(var_args)Resolves
to
to an absolute path. Ifto
isn't already absolutefrom
arguments are prepended in right to left order, until an absolute path is found. If after using allfrom
paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. Another way to think of it is as a sequence ofcd
commands in a shell.path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')
Is similar to:cd foo/bar cd /tmp/file/ cd .. cd a/../subfile pwd
The difference is that the different paths don't need to exist and may also be files. Examples:path.resolve('/foo/bar', './baz') // returns '/foo/bar/baz' path.resolve('/foo/bar', '/tmp/file/') // returns '/tmp/file' path.resolve('wwwroot', 'staticfiles/png/', '../gif/image.gif') // if currently in /home/myself/node, it returns '/home/myself/node/wwwroot/staticfiles/gif/image.gif'
- Parameters:
- {...string} var_args
- A list of path fragments to resolve.