Skip to content

Commit ddf13e0

Browse files
cjihrigMylesBorins
authored andcommitted
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]>
1 parent 5946b1e commit ddf13e0

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/api/fs.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -3588,7 +3588,8 @@ added: REPLACEME
35883588

35893589
* `path` {string|Buffer|URL}
35903590
* `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`.
35923593
* `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
35933594
`EPERM` error is encountered, Node.js will retry the operation with a linear
35943595
backoff wait of `retryDelay` milliseconds longer on each try. This option
@@ -3613,7 +3614,8 @@ added: REPLACEME
36133614

36143615
* `path` {string|Buffer|URL}
36153616
* `options` {Object}
3616-
* `force` Ignore errors
3617+
* `force` {boolean} When `true`, exceptions will be ignored if `path` does
3618+
not exist. **Default:** `false`.
36173619
* `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
36183620
`EPERM` error is encountered, Node.js will retry the operation with a linear
36193621
backoff wait of `retryDelay` milliseconds longer on each try. This option
@@ -5525,7 +5527,8 @@ added: REPLACEME
55255527

55265528
* `path` {string|Buffer|URL}
55275529
* `options` {Object}
5528-
* `force` Ignore errors
5530+
* `force` {boolean} When `true`, exceptions will be ignored if `path` does
5531+
not exist. **Default:** `false`.
55295532
* `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
55305533
`EPERM` error is encountered, Node.js will retry the operation with a linear
55315534
backoff wait of `retryDelay` milliseconds longer on each try. This option

0 commit comments

Comments
 (0)