diff options
| author | Jackson Tian <shyvo1987@gmail.com> | 2015-12-15 11:12:21 +0800 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2015-12-16 08:41:45 -0800 |
| commit | a8854e5b5981e473664440b2be4856594800f04e (patch) | |
| tree | b87e5286715ee5e84acb4fb51f30e131d8272408 /doc | |
| parent | 2859f9ef927f59965f3fce3ad66af400dcf05267 (diff) | |
| download | android-node-v8-a8854e5b5981e473664440b2be4856594800f04e.tar.gz android-node-v8-a8854e5b5981e473664440b2be4856594800f04e.tar.bz2 android-node-v8-a8854e5b5981e473664440b2be4856594800f04e.zip | |
doc: document the cache parameter for fs.realpathSync
PR-URL: https://github.com/nodejs/node/pull/4285
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/fs.markdown | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index 7c06803b3e..82f10d9ca1 100644 --- 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) |