summaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/is-retry-allowed/readme.md
blob: 4212d099b595649e9559f3f1b1b6c34b962c15ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# is-retry-allowed [![Build Status](https://travis-ci.org/floatdrop/is-retry-allowed.svg?branch=master)](https://travis-ci.org/floatdrop/is-retry-allowed)

Is retry allowed for Error?


## Install

```
$ npm install --save is-retry-allowed
```


## Usage

```js
const isRetryAllowed = require('is-retry-allowed');

isRetryAllowed({code: 'ETIMEDOUT'});
//=> true

isRetryAllowed({code: 'ENOTFOUND'});
//=> false

isRetryAllowed({});
//=> true
```


## API

### isRetryAllowed(error)

#### error

Type: `object`

Object with `code` property, which will be used to determine retry.


## License

MIT © [Vsevolod Strukchinsky](http://github.com/floatdrop)