Commit ddf13e0
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 <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>1 parent 5946b1e commit ddf13e0
1 file changed
Lines changed: 6 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3588,7 +3588,8 @@ added: REPLACEME | |||
| 3588 | 3588 | ||
| 3589 | 3589 | * `path` {string|Buffer|URL} | |
| 3590 | 3590 | * `options` {Object} | |
| 3591 | - * `force` don't error on nonexistent path | ||
| 3591 | + * `force` {boolean} When `true`, exceptions will be ignored if `path` does | ||
| 3592 | + not exist. **Default:** `false`. | ||
| 3592 | 3593 | * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or | |
| 3593 | 3594 | `EPERM` error is encountered, Node.js will retry the operation with a linear | |
| 3594 | 3595 | backoff wait of `retryDelay` milliseconds longer on each try. This option | |
@@ -3613,7 +3614,8 @@ added: REPLACEME | |||
| 3613 | 3614 | ||
| 3614 | 3615 | * `path` {string|Buffer|URL} | |
| 3615 | 3616 | * `options` {Object} | |
| 3616 | - * `force` Ignore errors | ||
| 3617 | + * `force` {boolean} When `true`, exceptions will be ignored if `path` does | ||
| 3618 | + not exist. **Default:** `false`. | ||
| 3617 | 3619 | * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or | |
| 3618 | 3620 | `EPERM` error is encountered, Node.js will retry the operation with a linear | |
| 3619 | 3621 | backoff wait of `retryDelay` milliseconds longer on each try. This option | |
@@ -5525,7 +5527,8 @@ added: REPLACEME | |||
| 5525 | 5527 | ||
| 5526 | 5528 | * `path` {string|Buffer|URL} | |
| 5527 | 5529 | * `options` {Object} | |
| 5528 | - * `force` Ignore errors | ||
| 5530 | + * `force` {boolean} When `true`, exceptions will be ignored if `path` does | ||
| 5531 | + not exist. **Default:** `false`. | ||
| 5529 | 5532 | * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or | |
| 5530 | 5533 | `EPERM` error is encountered, Node.js will retry the operation with a linear | |
| 5531 | 5534 | backoff wait of `retryDelay` milliseconds longer on each try. This option | |
0 commit comments