npmpackage.info

exponential-backoff

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

3.1.1

359

Apache-2.0

TypeScript

492,434,121 4.1

Installations

npm install exponential-backoff

Pull Requests

Open

5

Total

51

Closed

4

Merged

42

Issues

Open

4

Total

19

Closed

15

Releases

Unable to fetch releases

Developer

coveo

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

18.14.0

NPM Version

9.3.1 Statistics

359 Stars

93 Commits

26 Forks

10 Watching

2 Branches

4 Contributors

Updated on 14 Nov 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

492,434,121

Last day

-0.6%

1,906,238

Compared to previous day

Last week

4.4%

10,129,491

Compared to previous week

Last month

11%

41,848,649

Compared to previous month

Last year

297.9%

384,412,357

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

jest husky ts-jest prettier typescript @types/jest @types/node lint-staged

Versions

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 BackOffOptions object. It returns a Promise<T>.

1function backOff<T>(
2  request: () => Promise<T>,
3  options?: BackOffOptions
4): Promise<T>;

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

1import { backOff } from "exponential-backoff";
2
3function getWeather() {
4  return fetch("weather-endpoint");
5}
6
7async function main() {
8  try {
9    const response = await backOff(() => getWeather());
10    // process response
11  } catch (e) {
12    // handle error
13  }
14}
15
16main();

Migrating across major versions? Here are our breaking changes.

`BackOffOptions`

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, in milliseconds, 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 | Promise<boolean>

The retry function can be used to run logic after every failed attempt (e.g. logging a message, assessing the last error, etc.). It is called with the last error and the upcoming attempt number. Returning true will retry 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, in milliseconds, 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.

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.1

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to exponential-backoff

@ide/backoff

1.0.0

Computes truncated exponential backoff intervals with jitter

retry-cli

0.7.0

Retry with exponential backoff for the command line.

exponential-backoff-generator

2.0.1

Exponential backoff generator. Robust retry function.

backoff-rxjs

7.0.0

A collection of helpful RxJS operators to deal with backoff strategies (like exponential backoff)