doc: document the cache parameter for fs.realpathSync

PR-URL: #4285 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Dec 30, 2015 · c765db1 · c765db1
1 parent 9bbad89
commit c765db1
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)