summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/promise-retry/README.md
diff options
context:
space:
mode:
authorclaudiahdz <cghr1990@gmail.com>2019-11-18 21:01:39 +0200
committerMyles Borins <mylesborins@google.com>2019-11-20 19:16:47 -0500
commita7c7c703aff362f06ef5d49451a0f79fd289910f (patch)
tree48f9d01b32d55d420f229c4889a5a61178419223 /deps/npm/node_modules/promise-retry/README.md
parenta30a9f8193ddd61dfadc2d5d79784b682027b319 (diff)
downloadandroid-node-v8-a7c7c703aff362f06ef5d49451a0f79fd289910f.tar.gz
android-node-v8-a7c7c703aff362f06ef5d49451a0f79fd289910f.tar.bz2
android-node-v8-a7c7c703aff362f06ef5d49451a0f79fd289910f.zip
deps: upgrade npm to 6.13.1
PR-URL: https://github.com/nodejs/node/pull/30533 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'deps/npm/node_modules/promise-retry/README.md')
-rw-r--r--deps/npm/node_modules/promise-retry/README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/deps/npm/node_modules/promise-retry/README.md b/deps/npm/node_modules/promise-retry/README.md
index 85c3bc57e8..c50328374e 100644
--- a/deps/npm/node_modules/promise-retry/README.md
+++ b/deps/npm/node_modules/promise-retry/README.md
@@ -28,7 +28,7 @@ they were rather difficult to use or do not offer an easy way to do conditional
### promiseRetry(fn, [options])
Calls `fn` until the returned promise ends up fulfilled or rejected with an error different than
-a `retry` error.
+a `retry` error.
The `options` argument is an object which maps to the [retry](https://github.com/tim-kos/node-retry) module options:
- `retries`: The maximum amount of times to retry the operation. Default is `10`.
@@ -38,7 +38,7 @@ The `options` argument is an object which maps to the [retry](https://github.com
- `randomize`: Randomizes the timeouts by multiplying with a factor between `1` to `2`. Default is `false`.
-The `fn` function will receive a `retry` function as its first argument that should be called with an error whenever you want to retry `fn`. The `retry` function will always throw an error.
+The `fn` function will receive a `retry` function as its first argument that should be called with an error whenever you want to retry `fn`. The `retry` function will always throw an error.
If there's retries left, it will throw a special `retry` error that will be handled internally to call `fn` again.
If there's no retries left, it will throw the actual error passed to it.