Added error codes to errors. #26
Open
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.
Description
In #11, I described how error codes could be added to errors so consumers could programmatically figure out why jwt-auth failed and react accordingly. I think there was a miscommunication though because the codes were added to the error message itself rather than a property directly on the error. While consumer code could search for a particular error code within the error message, programmatically reacting to text within the message is usually frowned upon as the message is considered subject to change and isn't intended for programmatic decisioning.
In this PR, I'm demonstrating how we could add a
code
property to the error objects. The possible error codes are the ones found at the top of index.js and those in the Responses section of the endpoint documentation.I haven't added tests or updated the readme yet. I wanted to see if you would be amenable to this change first.
Related Issue
#9
Motivation and Context
Programmatically determine what caused an error to occur.
How Has This Been Tested?
So far, only manual testing.
Screenshots (if appropriate):
Types of changes
Checklist: