add the document of the new api routine: path.relative

pull/22966/head
Tony Huang 2011-08-04 11:39:19 +08:00 committed by koichik
parent 9e8d812ce9
commit 891a6f24a0
1 changed files with 19 additions and 0 deletions

View File

@ -71,6 +71,25 @@ Examples:
// if currently in /home/myself/node, it returns
'/home/myself/node/wwwroot/static_files/gif/image.gif'
### path.relative(from, to)
Solve the relative path from `from` to `to`.
Sometimes we've got two absolute pathes, and we need to calculate the relative path from one to another.
It's accually the reverse transform of path.resolve, which means we assume:
path.resolve(from, path.relative(from, to)) == path.resolve(to)
Examples:
path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// returns
'..\\..\\impl\\bbb'
path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns
'../../impl/bbb'
### path.dirname(p)
Return the directory name of a path. Similar to the Unix `dirname` command.