From ddf13e0df0c9388aee2c214e25d84e65280f890e Mon Sep 17 00:00:00 2001 From: cjihrig Date: Thu, 8 Oct 2020 16:38:09 -0400 Subject: [PATCH] doc: make fs.rm()'s force docs consistent This commit updates the documentation for the force option to fs.rm(). Prior to this commit, the documentation was inconsistent with the surrounding documentation. PR-URL: https://github.com/nodejs/node/pull/35561 Reviewed-By: Daijiro Wachi Reviewed-By: Ben Coe Reviewed-By: Jiawen Geng Reviewed-By: Harshitha K P Reviewed-By: Benjamin Gruenbaum Reviewed-By: Luigi Pinca Reviewed-By: Rich Trott --- doc/api/fs.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 86fef8cbd15636..a83d96fabb308a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3588,7 +3588,8 @@ added: REPLACEME * `path` {string|Buffer|URL} * `options` {Object} - * `force` don't error on nonexistent path + * `force` {boolean} When `true`, exceptions will be ignored if `path` does + not exist. **Default:** `false`. * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM` error is encountered, Node.js will retry the operation with a linear backoff wait of `retryDelay` milliseconds longer on each try. This option @@ -3613,7 +3614,8 @@ added: REPLACEME * `path` {string|Buffer|URL} * `options` {Object} - * `force` Ignore errors + * `force` {boolean} When `true`, exceptions will be ignored if `path` does + not exist. **Default:** `false`. * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM` error is encountered, Node.js will retry the operation with a linear backoff wait of `retryDelay` milliseconds longer on each try. This option @@ -5525,7 +5527,8 @@ added: REPLACEME * `path` {string|Buffer|URL} * `options` {Object} - * `force` Ignore errors + * `force` {boolean} When `true`, exceptions will be ignored if `path` does + not exist. **Default:** `false`. * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM` error is encountered, Node.js will retry the operation with a linear backoff wait of `retryDelay` milliseconds longer on each try. This option