Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

p-retry

Package Overview
Dependencies
2
Maintainers
1
Versions
17
Issues
File Explorer

Advanced tools

p-retry

Retry a promise-returning or async function

    5.1.2latest
    Github

Version published
Maintainers
1
Weekly downloads
10,852,828
decreased by-18.51%

Weekly downloads

Changelog

Source

  • Add Undici network error handling (#68) fb5f6f8

https://github.com/sindresorhus/p-retry/compare/v5.1.1...v5.1.2

Readme

Source

p-retry

Retry a promise-returning or async function

It does exponential backoff and supports custom retry strategies for failed operations.

Install

npm install p-retry

Usage

import pRetry, {AbortError} from 'p-retry'; import fetch from '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 AbortError(response.statusText); } return response.blob(); }; console.log(await pRetry(run, {retries: 5}));

API

pRetry(input, options?)

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 maximum number of retries is reached. It then rejects with the last rejection reason.

It does not retry on most TypeError's, with the exception of network errors. This is done on a best case basis as different browsers have different messages to indicate this. See whatwg/fetch#526 (comment)

input

Type: Function

Receives the current attempt number as the first argument and is expected to return a Promise or any value.

options

Type: object

Options are passed to the retry module.

onFailedAttempt(error)

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.

import pRetry from 'p-retry'; const run = async () => { const response = await fetch('https://sindresorhus.com/unicorn'); if (!response.ok) { throw new Error(response.statusText); } return response.json(); }; 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);

The onFailedAttempt function can return a promise. For example, you can do some async logging:

import pRetry from 'p-retry'; import logger from './some-logger'; const run = async () => { … }; const result = await pRetry(run, { onFailedAttempt: async error => { await logger.log(error); } });

If the onFailedAttempt function throws, all retries will be aborted and the original promise will reject with the thrown error.

signal

Type: AbortSignal

You can abort retrying using AbortController.

When AbortController.abort(reason) is called, the promise will be rejected with reason if it's an instance of Error, or a DOMException with reason as its message otherwise. If no reason is provided, the promise will reject with a DOMException.

Requires Node.js 16 or later.

import pRetry from 'p-retry'; const run = async () => { … }; const controller = new AbortController(); cancelButton.addEventListener('click', () => { controller.abort('User clicked cancel button'); }); try { await pRetry(run, {signal: controller.signal}); } catch (error) { console.log(error.message); //=> 'User clicked cancel button' }

AbortError(message)

AbortError(error)

Abort retrying and reject the promise.

message

Type: string

An error message.

error

Type: Error

A custom error.

Tip

You can pass arguments to the function being retried by wrapping it in an inline arrow function:

import pRetry from 'p-retry'; const run = async emoji => { // … }; // Without arguments await pRetry(run, {retries: 5}); // With arguments await pRetry(() => run('🦄'), {retries: 5});

Keywords

FAQs

What is p-retry?

Retry a promise-returning or async function

Is p-retry popular?

The npm package p-retry receives a total of 8,649,814 weekly downloads. As such, p-retry popularity was classified as popular.

Is p-retry well maintained?

We found that p-retry demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 23 Nov 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc