temporal-zod

Zod validators for Temporal types.

This depends on the temporal-polyfill package.

Usage

This library exports two Zod validators for each Temporal type: one with type coercion and one without.

Strings are coerced to the appropriate Temporal type, and for the Instant type, Date objects are also coerced to Instant objects.

• zPlainDate/zPlainDateInstance - A Zod validator for the PlainDate type.
• zPlainTime/zPlainTimeInstance - A Zod validator for the PlainTime type.
• zPlainDateTime/zPlainDateTimeInstance - A Zod validator for the PlainDateTime type.
• zPlainYearMonth/zPlainYearMonthInstance - A Zod validator for the PlainYearMonth type.
• zPlainMonthDay/zPlainMonthDayInstance - A Zod validator for the PlainMonthDay type.
• zDuration/zDurationInstance - A Zod validator for the Duration type.
• zInstant/zInstantInstance - A Zod validator for the Instant type. This also coerces Date objects to Instant objects.
• zZonedDateTime/zZonedDateTimeInstance - A Zod validator for the ZonedDateTime type.

Example

import * as z from "zod";
import { zZonedDateTime } from "temporal-zod";

const schema = z.object({
  zonedDateTime: zZonedDateTime,
});

const input = {
  zonedDateTime: "2023-05-15T13:45:30+08:00[Asia/Manila]",
};

const result = schema.parse(input);
// result.zonedDateTime is a ZonedDateTime object
Copy

You may view the tests for more examples.

With tRPC

If you are using tRPC, you likely use Zod to validate your inputs and outputs. However, when using it with Tanstack Query, since the Temporal types get mapped to an object, you should ensure that you are using the instance of the Temporal type rather than the one with type coercion. Otherwise, the query cache will not work as expected.

To do this, use the instance matcher of the Temporal type rather than the one with type coercion.

That is:

// wrong
const procedure = myProcedure.input(
  z.object({
    plainDate: zPlainDate,
  }),
);

// correct
const procedure = myProcedure.input(
  z.object({
    plainDate: zPlainDateInstance,
  }),
);
Copy

License

Apache-2.0