Improve error message for invalid JSON values #224
Merged
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.
Currently we use
assertStruct
in theJsonStruct
, to ensure that the value is JSON-serialisable before coercing it.assertStruct
returns a genericAssertionError
, and Superstruct doesn't have any information about where the error was thrown (such as the path). Given the following struct for example:An invalid
value
would result in anAssertionError
with the following message:After this change, a
StructError
is thrown instead, with the following message:This makes it more clear that the error happens at
value
, and it also makes more sense to throw aStructError
in this case.