Skip to content

Commit

Permalink
doc: make fs.rm()'s force docs consistent
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
cjihrig authored and MylesBorins committed Oct 14, 2020
1 parent 5946b1e commit ddf13e0
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/api/fs.md
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ddf13e0

Please sign in to comment.