diff options
author | cjihrig <cjihrig@gmail.com> | 2019-11-25 15:31:44 -0500 |
---|---|---|
committer | cjihrig <cjihrig@gmail.com> | 2019-11-27 18:27:11 -0500 |
commit | 7e85f068a48b284a253abcb5eb3173320869b8fe (patch) | |
tree | d29f0cd4a6ed32e156dadc0019b4f920258e8853 /doc/api | |
parent | 4059055739c1c395c00cf989d77073e862f9dae6 (diff) | |
download | android-node-v8-7e85f068a48b284a253abcb5eb3173320869b8fe.tar.gz android-node-v8-7e85f068a48b284a253abcb5eb3173320869b8fe.tar.bz2 android-node-v8-7e85f068a48b284a253abcb5eb3173320869b8fe.zip |
fs: make rimraf default to 0 retries
This commit makes retries an opt-in feature by defaulting
to no automatic retries. This will be particularly important
once synchronous operations can sleep between attempts.
Refs: https://github.com/nodejs/node/issues/30580
PR-URL: https://github.com/nodejs/node/pull/30644
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/fs.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index b96f635c1a..4a044f7296 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3222,7 +3222,8 @@ added: v0.0.2 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/30644 - description: The `maxBusyTries` option is renamed to `maxRetries`. + description: The `maxBusyTries` option is renamed to `maxRetries`, and its + default is 0. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -3252,7 +3253,7 @@ changes: * `maxRetries` {integer} If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is encountered, Node.js will retry the operation with a linear backoff wait of 100ms longer on each try. This option represents the number of retries. This - option is ignored if the `recursive` option is not `true`. **Default:** `3`. + option is ignored if the `recursive` option is not `true`. **Default:** `0`. * `recursive` {boolean} If `true`, perform a recursive directory removal. In recursive mode, errors are not reported if `path` does not exist, and operations are retried on failure. **Default:** `false`. @@ -3271,7 +3272,8 @@ added: v0.1.21 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/30644 - description: The `maxBusyTries` option is renamed to `maxRetries`. + description: The `maxBusyTries` option is renamed to `maxRetries`, and its + default is 0. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -3286,6 +3288,10 @@ changes: * `path` {string|Buffer|URL} * `options` {Object} + * `maxRetries` {integer} If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is + encountered, Node.js will retry the operation. This option represents the + number of retries. This option is ignored if the `recursive` option is not + `true`. **Default:** `0`. * `recursive` {boolean} If `true`, perform a recursive directory removal. In recursive mode, errors are not reported if `path` does not exist, and operations are retried on failure. **Default:** `false`. @@ -4998,7 +5004,8 @@ added: v10.0.0 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/30644 - description: The `maxBusyTries` option is renamed to `maxRetries`. + description: The `maxBusyTries` option is renamed to `maxRetries`, and its + default is 0. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -5016,7 +5023,7 @@ changes: * `maxRetries` {integer} If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is encountered, Node.js will retry the operation with a linear backoff wait of 100ms longer on each try. This option represents the number of retries. This - option is ignored if the `recursive` option is not `true`. **Default:** `3`. + option is ignored if the `recursive` option is not `true`. **Default:** `0`. * `recursive` {boolean} If `true`, perform a recursive directory removal. In recursive mode, errors are not reported if `path` does not exist, and operations are retried on failure. **Default:** `false`. |