0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api/path.markdown

125 lines
3.0 KiB
Markdown
Raw Normal View History

2010-10-28 14:18:16 +02:00
## Path
This module contains utilities for dealing with file paths. Use
`require('path')` to use it. It provides the following methods:
### path.normalize(p)
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'
2010-10-28 14:18:16 +02:00
### path.join([path1], [path2], [...])
Join all arguments together and normalize the resulting path.
Non-string arguments are ignored.
2010-10-28 14:18:16 +02:00
Example:
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns
2010-10-28 14:18:16 +02:00
'/foo/bar/baz/asdf'
path.join('foo', {}, 'bar')
// returns
'foo/bar'
### path.resolve([from ...], to)
2010-10-28 14:18:16 +02:00
2011-01-11 02:57:25 +01:00
Resolves `to` to an absolute path.
2010-10-28 14:18:16 +02:00
2011-01-11 02:57:25 +01:00
If `to` isn't already absolute `from` arguments are prepended in right to left
order, until an absolute path is found. If after using all `from` 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. Non-string arguments are ignored.
2010-10-28 14:18:16 +02:00
2011-01-11 02:57:25 +01:00
Another way to think of it is as a sequence of `cd` commands in a shell.
2010-10-28 14:18:16 +02:00
2011-01-11 02:57:25 +01:00
path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')
2010-10-28 14:18:16 +02:00
2011-01-11 02:57:25 +01:00
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:
2010-10-28 14:18:16 +02:00
path.resolve('/foo/bar', './baz')
// returns
2011-01-11 02:57:25 +01:00
'/foo/bar/baz'
2010-10-28 14:18:16 +02:00
path.resolve('/foo/bar', '/tmp/file/')
2010-10-28 14:18:16 +02:00
// returns
'/tmp/file'
path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
2011-01-11 02:57:25 +01:00
// if currently in /home/myself/node, it returns
'/home/myself/node/wwwroot/static_files/gif/image.gif'
2010-10-28 14:18:16 +02:00
### path.dirname(p)
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'
### path.basename(p, [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'
### path.extname(p)
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
2010-10-28 14:18:16 +02:00
'.html'
path.extname('index')
// returns
''
### path.exists(p, [callback])
Test whether or not the given path exists. Then, call the `callback` argument
with either true or false. Example:
2010-10-28 14:18:16 +02:00
path.exists('/etc/passwd', function (exists) {
util.debug(exists ? "it's there" : "no passwd!");
});
### path.existsSync(p)
Synchronous version of `path.exists`.