Skip to content
A utility that allows retrying a function with an exponential delay between attempts.
TypeScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc EB-3 Making first argument just the function to backoff (#6) Feb 9, 2019
src Add maxDelay option and unit tests (#13) Nov 4, 2019
.gitignore adding src and test files Jul 5, 2018
.npmignore adding .npmignore file Jul 6, 2018
.travis.yml update repo in travis.yml Nov 4, 2019
LICENSE Exporting IBackOffOptions interface (#9) Mar 23, 2019
README.md Add maxDelay option and unit tests (#13) Nov 4, 2019
package-lock.json 2.2.0 Nov 4, 2019
package.json
tsconfig.json EB-3 Making first argument just the function to backoff (#6) Feb 9, 2019

README.md

exponential-backoff

A utility that allows retrying a function with an exponential delay between attempts.

Installation

npm i exponential-backoff

Usage

The backOff<T> function takes a promise-returning function to retry, and an optional IBackOffOptions object. It returns a Promise<T>.

function backOff<T>(request: () => Promise<T>, options?: IBackOffOptions): Promise<T>

Here is an example retrying a function that calls a hypothetical weather endpoint:

import { backOff } from 'exponential-backoff';

function getWeather() {
    return fetch('weather-endpoint');
}

async function main() {
    try {
        const response = await backOff(() => getWeather());
        // process response
    }
    catch (e) {
        // handle error
    }
}

main();

Migrating from v1 to v2? Here are our breaking changes.

IBackOffOptions

  • delayFirstAttempt?: boolean

    Decides whether the startingDelay should be applied before the first call. If false, the first call will occur without a delay.

    Default value is false.

  • jitter?: JitterType | string

    Decides whether a jitter should be applied to the delay. Possible values are full and none.

    Default value is none.

  • maxDelay?: number

    The maximum delay between two consecutive attempts.

    Default value is Infinity.

  • numOfAttempts?: number

    The maximum number of times to attempt the function.

    Default value is 10.

    Minimum value is 1.

  • retry?: (e: any, attemptNumber: number) => boolean

    Everytime the function returns a rejected promise, the retry function is called with the error and the attempt number. Returning true will reattempt the function as long as the numOfAttempts has not been exceeded. Returning false will end the execution.

    Default value is a function that always returns true.

  • startingDelay?: number

    The delay before executing the function for the first time.

    Default value is 100 ms.

  • timeMultiple?: number

    The startingDelay is multiplied by the timeMultiple to increase the delay between reattempts.

    Default value is 2.

You can’t perform that action at this time.