Adding documentation for the type guard isAxiosError
#3767
Merged
Conversation
This file contains 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
mbargiel
pushed a commit
to mbargiel/axios
that referenced
this pull request
Jan 27, 2022
Co-authored-by: Jay <jasonsaayman@gmail.com>
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.
Instructions
isAxiosErroras requested in issue add isAxiosError to docs #3732Both mentioning the type guard and show a short example of how it can be used. The example uses
async/awaitas I felt it was the most natural way.I recommend merging this at the same time (or after) merging PR #3546 since it fixes the bug
isAxiosError(null) // true.This (#3645) is also a nice PR that would increase confidence in the type guard.
Closes #3732