summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-11-25 16:13:27 -0500
committercjihrig <cjihrig@gmail.com>2019-11-27 18:27:11 -0500
commit4c77a76ad91aaa7c4560c00c298bfcc74e49f573 (patch)
treedcb6a4550d9274b6ce300f95de37ecacb54cdc84 /doc
parent7e85f068a48b284a253abcb5eb3173320869b8fe (diff)
downloadandroid-node-v8-4c77a76ad91aaa7c4560c00c298bfcc74e49f573.tar.gz
android-node-v8-4c77a76ad91aaa7c4560c00c298bfcc74e49f573.tar.bz2
android-node-v8-4c77a76ad91aaa7c4560c00c298bfcc74e49f573.zip
fs: remove rimraf's emfileWait option
This commit removes the emfileWait option. EMFILE errors are now handled the same as any other retriable error. 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')
-rw-r--r--doc/api/fs.md35
1 files changed, 16 insertions, 19 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 4a044f7296..2b32379a58 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -3223,7 +3223,8 @@ changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/30644
description: The `maxBusyTries` option is renamed to `maxRetries`, and its
- default is 0.
+ default is 0. The `emfileWait` option has been removed, and
+ `EMFILE` errors use the same retry logic as other errors.
- version: v12.10.0
pr-url: https://github.com/nodejs/node/pull/29168
description: The `recursive`, `maxBusyTries`, and `emfileWait` options are
@@ -3246,14 +3247,11 @@ changes:
* `path` {string|Buffer|URL}
* `options` {Object}
- * `emfileWait` {integer} If an `EMFILE` error is encountered, Node.js will
- retry the operation with a linear backoff of 1ms longer on each try until the
- timeout duration passes this limit. This option is ignored if the `recursive`
- option is not `true`. **Default:** `1000`.
- * `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:** `0`.
+ * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `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:** `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`.
@@ -3273,7 +3271,8 @@ changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/30644
description: The `maxBusyTries` option is renamed to `maxRetries`, and its
- default is 0.
+ default is 0. The `emfileWait` option has been removed, and
+ `EMFILE` errors use the same retry logic as other errors.
- version: v12.10.0
pr-url: https://github.com/nodejs/node/pull/29168
description: The `recursive`, `maxBusyTries`, and `emfileWait` options are
@@ -5005,7 +5004,8 @@ changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/30644
description: The `maxBusyTries` option is renamed to `maxRetries`, and its
- default is 0.
+ default is 0. The `emfileWait` option has been removed, and
+ `EMFILE` errors use the same retry logic as other errors.
- version: v12.10.0
pr-url: https://github.com/nodejs/node/pull/29168
description: The `recursive`, `maxBusyTries`, and `emfileWait` options are
@@ -5016,14 +5016,11 @@ changes:
* `path` {string|Buffer|URL}
* `options` {Object}
- * `emfileWait` {integer} If an `EMFILE` error is encountered, Node.js will
- retry the operation with a linear backoff of 1ms longer on each try until the
- timeout duration passes this limit. This option is ignored if the `recursive`
- option is not `true`. **Default:** `1000`.
- * `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:** `0`.
+ * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `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:** `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`.