Skip to content

docs: add warning about object methods discarding refinements #5317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

docs: add warning about object methods discarding refinements #5317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/docs/content/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1031,6 +1031,12 @@ z.never(); // inferred type: `never`

## Objects


<Callout type="warn">
Object methods (`.pick()`, `.omit()`, `.extend()`, etc.) will discard the refinements defined on the base object. However, `.safeExtend()` will preserve them.
</Callout>


To define an object type:

```ts z.object
Expand Down