daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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: https://github.com/nodejs/node/pull/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>
pull/35561/head
cjihrig 2020-10-08 16:38:09 -04:00
parent 83eaaf9731
commit b8bd456839
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/fs.md
View File

@ -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