Skip to content

Commit 1527814

Browse files
cjihrigjoesepi
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: nodejs#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 5ba5bc0 commit 1527814

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
@@ -3612,7 +3612,8 @@ added: REPLACEME
36123612

36133613
* `path` {string|Buffer|URL}
36143614
* `options` {Object}
3615-
* `force` don't error on nonexistent path
3615+
* `force` {boolean} When `true`, exceptions will be ignored if `path` does
3616+
not exist. **Default:** `false`.
36163617
* `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
36173618
`EPERM` error is encountered, Node.js will retry the operation with a linear
36183619
backoff wait of `retryDelay` milliseconds longer on each try. This option
@@ -3637,7 +3638,8 @@ added: REPLACEME
36373638

36383639
* `path` {string|Buffer|URL}
36393640
* `options` {Object}
3640-
* `force` Ignore errors
3641+
* `force` {boolean} When `true`, exceptions will be ignored if `path` does
3642+
not exist. **Default:** `false`.
36413643
* `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
36423644
`EPERM` error is encountered, Node.js will retry the operation with a linear
36433645
backoff wait of `retryDelay` milliseconds longer on each try. This option
@@ -5555,7 +5557,8 @@ added: REPLACEME
55555557

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

0 commit comments

Comments
 (0)