docs: Add error handling section with examples #561
Merged
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
Adds a new "Error Handling" section to the README.md. This section explains how to catch `TokenError` exceptions and inspect the `code` property to determine the specific error. It includes code examples for handling: - Expired tokens (`FAST_JWT_EXPIRED`) - Invalid signatures due to key mismatch (`FAST_JWT_INVALID_SIGNATURE`) Addresses issue #560 by providing documentation on how to handle common token verification errors.
dosubot
bot
added
size:M
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a new "Error Handling" section to the README.md, providing documentation and examples on how to manage token verification errors, including token expiration and invalid signature scenarios.
- Added an "Error Handling" section to explain the use of TokenError and its code property.
- Included two code examples demonstrating error handling for expired tokens and invalid signatures.
|
LGTM - I tested the examples, they run as expected |
clabene
approved these changes
May 22, 2025
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.
Adds a new "Error Handling" section to the README.md.
This section explains how to catch
TokenErrorexceptions and inspect thecodeproperty to determine the specific error. It includes code examples for handling:FAST_JWT_EXPIRED)FAST_JWT_INVALID_SIGNATURE)Resolves #560 by providing documentation on how to handle common token verification errors.