Permalink
Browse files

doc: add cache argument to fs.realpath()

  • Loading branch information...
1 parent 70005be commit 21395aa03ca273e48e1e7e059b70eb464080b8e2 @shama committed Apr 16, 2012
Showing with 14 additions and 4 deletions.
  1. +14 −4 doc/api/fs.markdown
View
@@ -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 21395aa

Please sign in to comment.