lihai 8d6c751f49 feat: push | 2 роки тому | |
---|---|---|
.. | ||
index.js | 2 роки тому | |
license | 2 роки тому | |
package.json | 2 роки тому | |
readme.md | 2 роки тому |
Retry a promise-returning or async function
It does exponential backoff and supports custom retry strategies for failed operations.
$ npm install p-retry
const pRetry = require('p-retry');
const fetch = require('node-fetch');
const run = async () => {
const response = await fetch('https://sindresorhus.com/unicorn');
// Abort retrying if the resource doesn't exist
if (response.status === 404) {
throw new pRetry.AbortError(response.statusText);
}
return response.blob();
};
(async () => {
console.log(await pRetry(run, {retries: 5}));
})();
With the onFailedAttempt
option:
const run = async () => {
const response = await fetch('https://sindresorhus.com/unicorn');
if (response.status !== 200) {
throw new Error(response.statusText);
}
return response.json();
};
(async () => {
const result = await pRetry(run, {
onFailedAttempt: error => {
console.log(`Attempt ${error.attemptNumber} failed. There are ${error.retriesLeft} retries left.`);
// 1st request => Attempt 1 failed. There are 4 retries left.
// 2nd request => Attempt 2 failed. There are 3 retries left.
// …
},
retries: 5
});
console.log(result);
})();
Returns a Promise
that is fulfilled when calling input
returns a fulfilled promise. If calling input
returns a rejected promise, input
is called again until the max retries are reached, it then rejects with the last rejection reason.
It doesn't retry on TypeError
as that's a user error.
Type: Function
Receives the number of attempts as the first argument and is expected to return a Promise
or any value.
Type: Object
Options are passed to the retry
module.
Type: Function
Callback invoked on each retry. Receives the error thrown by input
as the first argument with properties attemptNumber
and retriesLeft
which indicate the current attempt number and the number of attempts left, respectively.
Abort retrying and reject the promise.
Type: string
Error message.
Type: Error
Custom error.
You can pass arguments to the function being retried by wrapping it in an inline arrow function:
const pRetry = require('p-retry');
const run = async emoji => {
// …
};
(async () => {
// Without arguments
await pRetry(run, {retries: 5});
// With arguments
await pRetry(() => run('🦄'), {retries: 5});
})();
MIT © Sindre Sorhus