Skip to content

docs: explain usage of in/out with shape #5297

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 2 commits into
base: main
Choose a base branch
from
Open

docs: explain usage of in/out with shape #5297

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccb7430
Docs: explain usage of in/out
mxdvl Sep 30, 2025
40879a5
fix: only what’s needed
mxdvl Sep 30, 2025
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
12 changes: 12 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 @@ -1157,6 +1157,18 @@ Dog.def.shape.age; // => number schema
</Tab>
</Tabs>

<Callout>
When a schema is transformed, the `shape` is accessed from the `in` or `out` key:

```ts
const Puppy = Dog.transform(({ age }) => age < 1);
Puppy.in.shape.name; // => string schema
Puppy.in.shape.age; // => number schema
Puppy.out; // => boolean schema
```

</Callout>

### `.keyof()`

To create a `ZodEnum` schema from the keys of an object schema:
Expand Down