From c765db1c364a51bd0c8b7e80f313f3cfbf825c8e Mon Sep 17 00:00:00 2001 From: Jackson Tian Date: Tue, 15 Dec 2015 11:12:21 +0800 Subject: [PATCH] doc: document the cache parameter for fs.realpathSync PR-URL: https://github.com/nodejs/node/pull/4285 Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- doc/api/fs.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index 8a84d6f1e82c7b..6b505dcadfa313 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)