Improve ZodErrorFilter
to only return first union error
#1256
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.
Summary
This extends the
ZodErrorFilter
to reduce the number of issues returned in the error payload when ainvalid_union
error is thrown byzod
.Instead of the error having multiple elements, e.g.:
it returns the first
issue
of theunionErrors
:Motivation
We only return the first
issue
of a "standard"ZodError
, removing any identifier that it is aZodError
, to reduce the error payload. This mirrors that withinvalid_union
errors.Changes
ZodErrorFiler['mapZodErrorResponse']
to extractissues
according totype