diff options
| author | cjihrig <cjihrig@gmail.com> | 2020-10-08 16:38:09 -0400 |
|---|---|---|
| committer | Myles Borins <mylesborins@github.com> | 2020-10-14 16:21:23 -0400 |
| commit | ddf13e0df0c9388aee2c214e25d84e65280f890e (patch) | |
| tree | 341d5e6bcc026ca3b3dfe836b309d8df0d6cacc8 | |
| parent | 5946b1ee23ee9aabf0daeb149e760faee9da1c97 (diff) | |
| download | node-new-ddf13e0df0c9388aee2c214e25d84e65280f890e.tar.gz | |
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 <daijiro.wachi@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
| -rw-r--r-- | doc/api/fs.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 86fef8cbd1..a83d96fabb 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 |