Skip to content

Commit

Permalink
Document that retry option doesn't work with streams
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Sep 8, 2019
1 parent c593428 commit 9088866
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Expand Up @@ -356,6 +356,8 @@ Default:

An object representing `limit`, `calculateDelay`, `methods`, `statusCodes`, `maxRetryAfter` and `errorCodes` fields for maximum retry count, retry handler, allowed methods, allowed status codes, maximum [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) time and allowed error codes.

**Note:** When using streams, this option is ignored.

If `maxRetryAfter` is set to `undefined`, it will use `options.timeout`.<br>
If [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header is greater than `maxRetryAfter`, it will cancel the request.

Expand Down

0 comments on commit 9088866

Please sign in to comment.