doc: add cache argument to fs.realpath()

pull/24503/head
Kyle Robinson Young 2012-04-16 14:52:44 -07:00 committed by Ben Noordhuis
parent 5bc07cc90b
commit 7cd1690f3d
1 changed files with 14 additions and 4 deletions

View File

@ -194,12 +194,22 @@ linkString)`.
Synchronous readlink(2). Returns the symbolic link's string value.
## fs.realpath(path, [callback])
## fs.realpath(path, [cache], callback)
Asynchronous realpath(2). The callback gets two arguments `(err,
resolvedPath)`. May use `process.cwd` to resolve relative paths.
Asynchronous realpath(2). The `callback` gets two arguments `(err,
resolvedPath)`. May use `process.cwd` to resolve relative paths. `cache` is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional `fs.stat` calls for known real paths.
## fs.realpathSync(path)
Example:
var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
if (err) throw err;
console.log(resolvedPath);
});
## fs.realpathSync(path, [cache])
Synchronous realpath(2). Returns the resolved path.