Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): Document cause argument to onRetry #173

Merged
merged 1 commit into from Oct 4, 2022
Merged

docs(readme): Document cause argument to onRetry #173

merged 1 commit into from Oct 4, 2022

Conversation

jmpage
Copy link
Contributor

@jmpage jmpage commented Sep 12, 2022 •
edited

onRetry is always called with one of the following:

  1. A response from minipass-fetch

make-fetch-happen/lib/remote.js

Line 83 in 2631db8

options.onRetry(res)

  1. An error thrown by or from a rejected promise from minipass-fetch or promise-retry

make-fetch-happen/lib/remote.js

Line 106 in 2631db8

options.onRetry(err)

This PR updates the documentation to reflect this.

I have not added an entry to the changelog as it is not requested in the contribution guide and I don't believe that this change merits one.

@jmpage jmpage requested a review from a team as a code owner September 12, 2022 21:35
@wraithgar wraithgar self-assigned this Sep 14, 2022
@wraithgar wraithgar changed the title Document cause argument to onRetry docs(readme): Document cause argument to onRetry Oct 4, 2022
@wraithgar wraithgar merged commit d63de44 into npm:main Oct 4, 2022
@github-actions github-actions bot mentioned this pull request Oct 4, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@wraithgar wraithgar

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jmpage @wraithgar