We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
Originally came up here https://twitter.com/JasonKuhrt/status/1443331235598700544
Idea is that it would be great to be able to add descriptions to schema types so that it can be passed off to other destinations.
Example:
const foo = z.object({ bar: z.string().description(`about bar`) }).description(`about foo`)
The text was updated successfully, but these errors were encountered:
Added in zod@3.11.4! 👍
Slight change to proposed API:
const schema = z.string().describe("A description."); schema.description; // => "A description."
Sorry, something went wrong.
Already documented ? I can't find any information about .describe() in offical doc . @colinhacks
.describe()
No branches or pull requests
Originally came up here https://twitter.com/JasonKuhrt/status/1443331235598700544
Idea is that it would be great to be able to add descriptions to schema types so that it can be passed off to other destinations.
Example:
The text was updated successfully, but these errors were encountered: