Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FGRibreau committed Mar 23, 2014
1 parent e524ce9 commit b6ac75f
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

When the connection fails with one of `ECONNRESET`, `ENOTFOUND`, `ESOCKETTIMEDOUT`, `ETIMEDOUT`, `ECONNREFUSED` or when an HTTP 5xx error occurrs, the request will automatically be re-attempted as these are often recoverable errors and will go away on retry.

# Usage
## Usage

Request-retry is a drop-in replacement for [request](https://github.com/mikeal/request) but adds two new options `maxAttempts` and `retryDelay`.

Expand All @@ -29,6 +29,12 @@ Install with [npm](https://npmjs.org/package/requestretry).

npm install --save requestretry

## Todos

- Tests
- Use an EventEmitter to notify retries
- Allow the end-user to specify its own conditions to trigger a retry

## Changelog

v1.0.0: Initial commit
Expand Down

0 comments on commit b6ac75f

Please sign in to comment.