This repository has been archived by the owner. It is now read-only.
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
157 lines (104 sloc) 3.7 KB


Stability: 3 - Stable

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

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


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

When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On windows backslashes are used.


// returns

path.join([path1], [path2], [...])

Join all arguments together and normalize the resulting path. Non-string arguments are ignored.


path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns

path.join('foo', {}, 'bar')
// returns

path.resolve([from ...], to)

Resolves to to an absolute path.

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.

Another way to think of it is as a sequence of cd 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

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


path.resolve('/foo/bar', './baz')
// returns

path.resolve('/foo/bar', '/tmp/file/')
// returns

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// if currently in /home/myself/node, it returns

path.relative(from, to)

Solve the relative path from from to to.

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

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


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

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns


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


// returns

path.basename(p, [ext])

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


// returns

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// returns


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 of the path or the first character of it is '.', then it returns an empty string. Examples:

// returns

// returns

// returns


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

An example on linux:

// returns
['foo', 'bar', 'baz']

An example on windows:

// returns
['foo', 'bar', 'baz']