Repository navigation
docs(parser): document reporting errors from schema transforms - #5838
Merged
Merged
Conversation
dreamorosi
approved these changes
Oct 23, 2026
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
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.
Summary
Zod doesn't catch errors thrown inside a
transform, so they are thrown even whensafeParseis used ("Transform functions should never throw", Zod docs). This PR documents that behaviour in the parser docs and shows how to report a transform failure as a validation error withctx.issuesandz.NEVER, the same way the built-in helpers likeJSONStringifieddo.Changes
docs/features/parser.md, explaining that thrown errors aren't caught and showing thectx.issues.push/z.NEVERpattern.examples/snippets/parser/transformIssues.tssnippet, a transform that catches theURIErrorfromdecodeURIComponentand reports it as acustomissue.safeParsedoesn't catch errors thrown by a schema's transform, linking to the new subsection.Issue number: closes #5769
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
🤖 Generated with Claude Code