# retryify
> Wrap a function to retry on specific errors
Latest version **6.0.0** (published 2022-05-19) · MIT license · 0 weekly downloads
## Install
```sh
npm install retryify
pnpm add retryify
yarn add retryify
bun add retryify
```
## 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 | 6.0.0 |
| Published | 2022-05-19 |
| First published | 2015-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 0 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Smartcar |
| Maintainers | smartcarops, gurpreetatwal, smartcar-ci, sankethkatta |
| Keywords | retryify, retry, promise, decorator, wrapper, timeout, repeat |
## Links
- npm: https://www.npmjs.com/package/retryify
- Repository: https://github.com/smartcar/retryify
- Homepage: https://github.com/smartcar/retryify#readme
- Issues: https://github.com/smartcar/retryify/issues
- npm.io page: https://npm.io/package/retryify
## Alternatives
- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads
## Recent versions
- 6.0.0 (latest) — 2022-05-19
- 4.0.0-beta.1 (beta) — 2019-12-01
- 5.1.0 — 2022-04-29
- 5.0.1 — 2020-07-15
- 5.0.0 — 2020-07-15
- 4.1.0 — 2020-06-29
- 4.0.0 — 2019-12-18
- 3.0.0 — 2019-07-24
- 2.0.2 — 2019-05-29
- 2.0.1 — 2019-01-02
- 2.0.0 — 2018-07-12
- 1.1.1 — 2017-10-09
- 1.1.0 — 2016-10-20
- 1.0.5 — 2015-10-31
- 1.0.4 — 2015-06-12
- … 3 more at https://npm.io/package/retryify/versions
## README
# retryify [![NPM version][npm-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coverage Status][coverage-image]][coverage-url] [![Greenkeeper][gk-image]][gk-url]
Quickly and easily wrap functions to make them retry when they fail.
## Installation
```bash
$ npm install retryify
```
## Example
```js
// create a new retryify wrapper with some options set.
const retryify = require('retryify')({
retries: 5,
timeout: 1000,
factor: 2,
errors: [RequestError, StatusCodeError],
log: function(msg) { console.log(msg); },
});
// promisified request library
const request = require('request-promise');
// get will now retry each time it catches a RequestError or a
// StatusCodeError, it retries 5 times, or the request finally resolves
// successfully.
const get = retryify(function(url) {
return request(url);
});
// or, add some custom options for this specific function
const post = retryify({
retries: 10
}, function(url, data) {
return request({
uri: url,
method: 'POST',
});
});
// send the request, but retry if it fails.
get('http://google.com')
.then(...)
.catch(...);
```
## retryify([options]) ⇒ function
Retry module setup function. Takes an options object that configures the
default retry options.
**Kind**: global function
**Returns**: function - [retryWrapper](retryWrapper) A decorator function that wraps a
a function to turn it into a retry-enabled function.
**Throws**:
- TypeError when function is passed instead of options object.
To use retryify it first must be "constructed" by passing in an options
object and the returned function is what is supposed to take the function
to retry.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | [Options](#Options) | {} | Optional configuration object |
### retryify~retryWrapper([innerOptions], fn) ⇒ function
retryify function decorator. Allows configuration on a function by function
basis.
**Kind**: inner method of [retryify](#retryify)
**Returns**: function - The wrapped function.
| Param | Type | Description |
| --- | --- | --- |
| [innerOptions] | [Options](#Options) | Optional configuration object. Same format as above. |
| fn | function | The function to wrap. Will retry the function if any matching errors are caught. |
## Options : Object
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [options.retries] | Number | 3 | Number of times to retry a wrapped function |
| [options.initialDelay] | Number | 0 | Amount of time (ms) to wait before any function attempts |
| [options.timeout] | Number | 300 | Amount of time (ms) to wait between retries |
| [options.factor] | Number | 2 | The exponential factor to scale the timeout by every retry iteration. For example: with a factor of 2 and a timeout of 100 ms, the first retry will fire after 100 ms, the second after 200 ms, the third after 400 ms, etc.... The formula used to calculate the delay between each retry: ```timeout * Math.pow(factor, attempts)``` |
| [options.shouldRetry] | function | () => true | Invoked with the thrown error, retryify will retry if this method returns true. |
| [options.log] | function | | Logging function that takes a message as |
[npm-url]: https://www.npmjs.com/package/retryify
[npm-image]: https://img.shields.io/npm/v/retryify.svg?style=flat-square
[ci-url]: https://travis-ci.com/smartcar/retryify
[ci-image]: https://img.shields.io/travis/com/smartcar/retryify/master.svg?style=flat-square
[coverage-url]: https://codecov.io/gh/smartcar/retryify
[coverage-image]: https://img.shields.io/codecov/c/github/smartcar/retryify/master.svg?style=flat-square
[gk-url]: https://greenkeeper.io
[gk-image]: https://badges.greenkeeper.io/smartcar/retryify.svg?style=flat-square
---
_Source: https://npm.io/package/retryify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._