Skip to content

Commit a8854e5

Browse files
JacksonTianjasnell
authored andcommitted
doc: document the cache parameter for fs.realpathSync
PR-URL: #4285 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 2859f9e commit a8854e5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/fs.markdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,9 @@ Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
634634

635635
## fs.realpathSync(path[, cache])
636636

637-
Synchronous realpath(2). Returns the resolved path.
637+
Synchronous realpath(2). Returns the resolved path. `cache` is an
638+
object literal of mapped paths that can be used to force a specific path
639+
resolution or avoid additional `fs.stat` calls for known real paths.
638640

639641
## fs.rename(oldPath, newPath, callback)
640642

0 commit comments

Comments
 (0)