Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

doc: add cache argument to fs.realpath()

  • Loading branch information...
shama authored and bnoordhuis committed Apr 16, 2012
1 parent 5bc07cc commit 7cd1690f3dab62fea1c06ab26ade985cb1c85740
Showing with 14 additions and 4 deletions.
  1. +14 −4 doc/api/fs.markdown
@@ -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.

0 comments on commit 7cd1690

Please sign in to comment.
You can’t perform that action at this time.