doc: document the cache parameter for fs.realpathSync

PR-URL: nodejs#4285 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
scovetta · Apr 2, 2016 · a6fd7c6 · a6fd7c6
1 parent 6cec309
commit a6fd7c6
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown
@@ -634,7 +634,9 @@ Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
 
 ## fs.realpathSync(path[, cache])
 
-Synchronous realpath(2). Returns the resolved path.
+Synchronous realpath(2). Returns the resolved path. `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.rename(oldPath, newPath, callback)