# @zeit/fetch-retry

> A layer on top of `fetch` (via [node-fetch](https://www.npmjs.com/package/node-fetch)) with sensible defaults for retrying to prevent common errors.

Latest version **5.0.1** (published 2020-10-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zeit/fetch-retry
pnpm add @zeit/fetch-retry
yarn add @zeit/fetch-retry
bun add @zeit/fetch-retry
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2020-10-14 |
| First published | 2017-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | leerobinson, hankvercel, okbel, samsisle, cleishm, nazarenooviedo, maxleiter, chibicode, gielcobben, jaredpalmer, jkrems, prateekbh, kikobeats, gmonaco, housseindjirdeh, developit, spanicker, keanulee, atcastle, janicklas-ralph, skllcrn, paco, guybedford, ragojose, williamli, msweeneydev, coetry, rabaut, lfades, mfix22, ijjk, arzafran, umegaya, sarupbanskota, timer, anatrajkovska, paulogdm, andybitz, mglagola, lucleray, zeit-bot, styfle, juancampa, dav-is, quietshu, fivepointseven, joecohens, codetheory, matheuss, igorklopov, leo, nkzawa, tootallnate, rauchg, timneutkens, javivelasco, iamevilrabbit |

## Links

- npm: https://www.npmjs.com/package/@zeit/fetch-retry
- npm.io page: https://npm.io/package/@zeit/fetch-retry

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [async-retry](https://npm.io/package/async-retry.md) ^1.3.1

## Recent versions

- 5.0.1 (latest) — 2020-10-14
- 5.0.0 — 2020-03-03
- 4.1.0 — 2020-01-02
- 4.0.1 — 2019-07-11
- 4.0.0 — 2019-03-08
- 3.0.0 — 2018-03-27
- 2.0.0 — 2017-10-19
- 1.0.1 — 2017-10-19
- 1.0.0 — 2017-10-14

## README

# fetch-retry [![CircleCI](https://circleci.com/gh/zeit/fetch-retry.svg?style=svg)](https://circleci.com/gh/zeit/fetch-retry)

A layer on top of `fetch` (via [node-fetch](https://www.npmjs.com/package/node-fetch))
with sensible defaults for retrying to prevent common errors.

## How to use

`fetch-retry` is a drop-in replacement for `fetch`:

```js
const fetch = require('@zeit/fetch-retry')(require('node-fetch'))

module.exports = async () => {
  const res = await fetch('http://localhost:3000')
  console.log(res.status);
}
```

Make sure to `yarn add @zeit/fetch-retry` in your main package.

Note that you can pass [retry options](https://github.com/zeit/async-retry) to using `opts.retry`.
We also provide a `opts.onRetry` and `opts.retry.maxRetryAfter` options.

`opts.onRetry` is a customized version of `opts.retry.onRetry` and passes
not only the `error` object in each retry but also the current `opts` object.

`opts.retry.maxRetryAfter` is the max wait time according to the `Retry-After` header.
If it exceeds the option value, stop retrying and returns the error response. It defaults to `20`.

## Rationale

Some errors are very common in production (like the underlying `Socket`
yielding `ECONNRESET`), and can easily and instantly be remediated
by retrying.

The default behavior of `fetch-retry` is to attempt retries **10**, **60**
**360**, **2160** and **12960** milliseconds (a total of 5 retries) after
a *network error*, *429* or *5xx* error occur.

The idea is to provide a sensible default: most applications should
continue to perform correctly with a worst case scenario of a given
request having an additional 15550ms overhead.

On the other hand, most applications that use `fetch-retry` instead of
vanilla `fetch` should see lower rates of common errors and fewer 'glitches'
in production.

## Tests

To run rests, execute

```console
npm test
```

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