Ability to customize whether an error should be retried #67
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | ||
| Callback invoked on to determine whether a retry should occur. Receives the error thrown by `input` as the first argument with properties `attemptNumber` and `retriesLeft` which indicate the current attempt number and the number of attempts left, respectively. | ||
|
|
||
| `shouldRetry` will not allow AbortError overrides. It allows overriding the default retry logic (aborting on TypeError's that aren't network errors) for all other errors. |
There was a problem hiding this comment.
shouldRetrywill not allow AbortError overrides.
I don't think it's clear enough what this means. I would spell it out more explicitly. That this cannot be used to prevent an aborted operation (AbortError).
There was a problem hiding this comment.
Got it! Will update this to make it clear on what this does and how it behaves.
| }); | ||
| ``` | ||
|
|
||
| If the `onFailedAttempt` function throws, all retries will be aborted and the original promise will reject with the thrown error. |
There was a problem hiding this comment.
This should be placed above the example.
| @@ -17,6 +17,8 @@ export interface FailedAttemptError extends Error { | |||
| readonly retriesLeft: number; | |||
| } | |||
|
|
|||
| export function shouldRetry(error: FailedAttemptError): boolean; | |||
There was a problem hiding this comment.
This needs a doc comment about its purpose is.
|
Thanks for working on this. You also need to add the docs to the readme. |
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
|
Friendly bump :) |
|
Closing for lack of response: #70 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I saw #46 and thought it would be a quick addition.
I've added tests, exported the original retry logic, and added the types.
Fixes #46