Skip to content
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

Readme: Reference coerce in "Supporting date strings" section #1841

Closed
wants to merge 2 commits into from
Closed

Readme: Reference coerce in "Supporting date strings" section #1841

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62be7d9
Readme: Reference `coerce` in "Supporting date strings" section
tordans Jan 10, 2023
cb839e3
Typo
tordans Jan 10, 2023
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
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,18 +731,9 @@ z.date().max(new Date(), { message: "Too young!" });

**Supporting date strings**

To write a schema that accepts either a `Date` or a date string, use [`z.preprocess`](#preprocess).
Since [zod 3.20](https://github.com/colinhacks/zod/releases/tag/v3.20), use [`z.coerce.date()`](#coercion-for-primitives) to pass the input through `new Date(input)`.

```ts
const dateSchema = z.preprocess((arg) => {
if (typeof arg == "string" || arg instanceof Date) return new Date(arg);
}, z.date());
type DateSchema = z.infer<typeof dateSchema>;
// type DateSchema = Date

dateSchema.safeParse(new Date("1/12/22")); // success: true
dateSchema.safeParse("2022-01-12T00:00:00.000Z"); // success: true
```
For older zod versions, use [`z.preprocess`](#preprocess) like [described in this thread](https://github.com/colinhacks/zod/discussions/879#discussioncomment-2036276).

## Zod enums

Expand Down