docs: clarify exactOptional pipe behavior applies to object schemas #2
Conversation
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
- Add important notes about pipe execution for missing keys - Explain that default values are required for pipe execution - Improve clarity across optional, exactOptional, and guides - Enhance understanding of transformation behavior
Co-authored-by: Perdolique <[email protected]>
Co-authored-by: Perdolique <[email protected]>
Copilot
AI
changed the title
[WIP] Handle this thing @fabian-hiller/valibot/pull/1304
docs: clarify exactOptional pipe behavior applies to object schemas
Sep 13, 2025
Copilot finished work on behalf of
Perdolique
September 13, 2025 17:29
Perdolique
reviewed
Sep 13, 2025
Co-authored-by: Perdolique <[email protected]>
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.
This PR addresses review feedback from PR fabian-hiller#1304 to improve clarity in the
exactOptionaldocumentation regarding when pipe actions are executed.Problem
The
exactOptionaldocumentation had an important note about pipe behavior that wasn't clear enough about the specific context where this behavior applies. The maintainer feedback indicated that it should clarify this only happens when using optional schemas with object schemas.Solution
Updated the important note in
exactOptional/index.mdxto match the clarity already present inoptional/index.mdx:Before:
> **Important**: When a key is missing and no `default_` value is provided, the schema's pipe (including transformations) will not be executed.After:
> **Important**: When used in object schemas, if a key is missing and no `default_` value is provided, the schema's pipe (including transformations) will not be executed.Impact
optionalandexactOptionaldocumentation now have consistent messagingThis is a documentation-only change that improves user understanding without affecting any functionality.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.