Skip to content

Commit

Permalink
doc: document the cache parameter for fs.realpathSync
Browse files Browse the repository at this point in the history
PR-URL: nodejs#4285
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
JacksonTian authored and Michael Scovetta committed Apr 2, 2016
1 parent 6cec309 commit a6fd7c6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/fs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit a6fd7c6

Please sign in to comment.