Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve fs.rm() docs #35561

Merged
merged 2 commits into from
Oct 10, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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: #35561
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Ben Coe <[email protected]>
Reviewed-By: Jiawen Geng <[email protected]>
Reviewed-By: Harshitha K P <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
cjihrig committed Oct 10, 2020
commit b8bd45683941e15a706faf096a691d9267374855
9 changes: 6 additions & 3 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
@@ -3612,7 +3612,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
@@ -3637,7 +3638,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
@@ -5555,7 +5557,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