diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-11-25 15:04:18 -0500 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-11-27 18:27:11 -0500 |
| commit | 4059055739c1c395c00cf989d77073e862f9dae6 (patch) | |
| tree | 218dbe11b5f0931b09b14ce5284e579d8512fe7b /doc/api | |
| parent | 84aa19270d2d2736f1e18b359e3531b76db788d3 (diff) | |
| download | android-node-v8-4059055739c1c395c00cf989d77073e862f9dae6.tar.gz android-node-v8-4059055739c1c395c00cf989d77073e862f9dae6.tar.bz2 android-node-v8-4059055739c1c395c00cf989d77073e862f9dae6.zip | |
fs: rename rimraf's maxBusyTries to maxRetries
This is part of reworking the rimraf retry logic.
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 | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index de0acff8ea..b96f635c1a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3220,6 +3220,9 @@ Synchronous rename(2). Returns `undefined`. <!-- YAML added: v0.0.2 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/30644 + description: The `maxBusyTries` option is renamed to `maxRetries`. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -3246,7 +3249,7 @@ changes: 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`. - * `maxBusyTries` {integer} If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is + * `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`. @@ -3266,6 +3269,9 @@ Windows and an `ENOTDIR` error on POSIX. <!-- YAML added: v0.1.21 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/30644 + description: The `maxBusyTries` option is renamed to `maxRetries`. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -4990,6 +4996,9 @@ upon success. <!-- YAML added: v10.0.0 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/30644 + description: The `maxBusyTries` option is renamed to `maxRetries`. - version: v12.10.0 pr-url: https://github.com/nodejs/node/pull/29168 description: The `recursive`, `maxBusyTries`, and `emfileWait` options are @@ -5004,7 +5013,7 @@ changes: 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`. - * `maxBusyTries` {integer} If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is + * `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`. |