# @insertish/exponential-backoff

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

Latest version **3.1.0-patch.2** (published 2022-04-27) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @insertish/exponential-backoff
pnpm add @insertish/exponential-backoff
yarn add @insertish/exponential-backoff
bun add @insertish/exponential-backoff
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0-patch.2 |
| Published | 2022-04-27 |
| First published | 2021-12-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 50.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 408 |
| Author | Sami Sayegh |
| Maintainers | insertish |
| Keywords | exponential, backoff, retry |

## Links

- npm: https://www.npmjs.com/package/@insertish/exponential-backoff
- Repository: https://github.com/coveo/exponential-backoff
- Homepage: https://github.com/coveo/exponential-backoff#readme
- Issues: https://github.com/coveo/exponential-backoff/issues
- npm.io page: https://npm.io/package/@insertish/exponential-backoff

## Recent versions

- 3.1.0-patch.2 (latest) — 2022-04-27
- 3.1.0-patch.1 — 2022-04-27
- 3.1.0-patch.0 — 2021-12-24
- 3.1.0 — 2021-12-23

## README

# 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>`.

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

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

```js
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 across major versions? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/migration-guide.md).

### `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](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-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`.

---
_Source: https://npm.io/package/@insertish/exponential-backoff · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
