Skip to content

docs: clarify safeParse callback errors#127

Merged
leoafarias merged 1 commit into
mainfrom
chore/documenation-update
Jul 15, 2026
Merged

docs: clarify safeParse callback errors#127
leoafarias merged 1 commit into
mainfrom
chore/documenation-update

Conversation

@leoafarias

Copy link
Copy Markdown
Member

Summary

  • scope the safeParse Error rethrow guarantee to constraint and refinement callbacks
  • document that codec/transform decoders and safeParseAs mappers return SchemaTransformError failures for thrown values, including Error values
  • keep the API reference, quickstart, and llms.txt guidance aligned

Why

PR #126 corrected the old “never throws” wording, but the replacement made the Error rethrow guarantee appear universal. The runtime intentionally wraps transform and mapper callback failures, so the documentation needs to distinguish those callback categories.

This is documentation-only and does not change runtime behavior.

Validation

  • npx --yes @docs.page/cli check
  • focused callback-error contract tests: 5 passed
  • git diff --check origin/main...HEAD

@docs-page

docs-page Bot commented Jul 15, 2026

Copy link
Copy Markdown

To preview the documentation for this pull request, visit the following URL:

docs.page/btwld/ack~127

Documentation is deployed and generated using docs.page

@leoafarias
leoafarias marked this pull request as ready for review July 15, 2026 11:27
@leoafarias
leoafarias merged commit 25f08c9 into main Jul 15, 2026
3 checks passed
@leoafarias
leoafarias deleted the chore/documenation-update branch July 15, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant