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.

Sign up for GitHub

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

doc: improve fs.rm() docs #35561

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8bd456
doc: make fs.rm()'s force docs consistent
cjihrig Oct 8, 2020
71a48c3
doc: remove incorrect synchronous label
cjihrig Oct 8, 2020
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
13 changes: 8 additions & 5 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -5567,8 +5570,8 @@ added: REPLACEME
retries. This option is ignored if the `recursive` option is not `true`.
**Default:** `100`.

Synchronously removes files and directories (modeled on the standard POSIX `rm`
utility). Resolves the `Promise` with no arguments on success.
Removes files and directories (modeled on the standard POSIX `rm` utility).
Resolves the `Promise` with no arguments on success.

### `fsPromises.stat(path[, options])`
<!-- YAML
Expand Down