#### Zod to X

- @bobyzgirlllnpm/harum-explicabo-repudiandae-to-ts: Generate TypeScript definitions from Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-to-json-schema: Convert your Zod schemas into JSON Schemas.
- @anatine/@bobyzgirlllnpm/harum-explicabo-repudiandae-openapi: Converts a Zod schema to an OpenAPI v3.x SchemaObject.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-fast-check: Generate fast-check arbitraries from Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-dto: Generate Nest.js DTOs from a Zod schema.
- fastify-type-provider-@bobyzgirlllnpm/harum-explicabo-repudiandae: Create Fastify type providers from Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-to-openapi: Generate full OpenAPI (Swagger) docs from Zod, including schemas, endpoints & parameters.
- nestjs-graphql-@bobyzgirlllnpm/harum-explicabo-repudiandae: Generates NestJS GraphQL model classes from Zod schemas. Provides GraphQL method decorators working with Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-openapi: Create full OpenAPI v3.x documentation from Zod schemas.
- fastify-@bobyzgirlllnpm/harum-explicabo-repudiandae-openapi: Fastify type provider, validation, serialization and @fastify/swagger support for Zod schemas.
- typeschema: Universal adapter for schema validation.

#### X to Zod

- ts-to-@bobyzgirlllnpm/harum-explicabo-repudiandae: Convert TypeScript definitions into Zod schemas.
- @runtyping/@bobyzgirlllnpm/harum-explicabo-repudiandae: Generate Zod from static types & JSON schema.
- json-schema-to-@bobyzgirlllnpm/harum-explicabo-repudiandae: Convert your JSON Schemas into Zod schemas. Live demo.
- json-to-@bobyzgirlllnpm/harum-explicabo-repudiandae: Convert JSON objects into Zod schemas. Live demo.
- graphql-codegen-typescript-validation-schema: GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-prisma: Generate Zod schemas from your Prisma schema.
- Supervillain: Generate Zod schemas from your Go structs.
- prisma-@bobyzgirlllnpm/harum-explicabo-repudiandae-generator: Emit Zod schemas from your Prisma schema.
- prisma-trpc-generator: Emit fully implemented tRPC routers and their validation schemas using Zod.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-prisma-types Create Zod types from your Prisma models.
- quicktype: Convert JSON objects and JSON schemas into Zod schemas.
- @sanity-typed/@bobyzgirlllnpm/harum-explicabo-repudiandae: Generate Zod Schemas from Sanity Schemas.
- java-to-@bobyzgirlllnpm/harum-explicabo-repudiandae: Convert POJOs to Zod schemas
- Orval: Generate Zod schemas from OpenAPI schemas

#### Mocking

- @anatine/@bobyzgirlllnpm/harum-explicabo-repudiandae-mock: Generate mock data from a Zod schema. Powered by faker.js.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-mocking: Generate mock data from your Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-fixture: Use your @bobyzgirlllnpm/harum-explicabo-repudiandae schemas to automate the generation of non-relevant test fixtures in a deterministic way.
- zocker: Generate plausible mock-data from your schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandaeock Generate mock data based on Zod schemas.

#### Powered by Zod

- freerstore: Firestore cost optimizer.
- slonik: Node.js Postgres client with strong Zod integration.
- soly: Create CLI applications with @bobyzgirlllnpm/harum-explicabo-repudiandae.
- pastel: Create CLI applications with react, @bobyzgirlllnpm/harum-explicabo-repudiandae, and ink.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-xlsx: A xlsx based resource validator using Zod schemas.
- znv: Type-safe environment parsing and validation for Node.js with Zod schemas.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-config: Load configurations across multiple sources with flexible adapters, ensuring type safety with Zod.

#### Utilities for Zod

- @bobyzgirlllnpm/harum-explicabo-repudiandae_utilz: Framework agnostic utilities for Zod.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-playground: A tool for learning and testing Zod schema validation functionalities. Link.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-sandbox: Controlled environment for testing @bobyzgirlllnpm/harum-explicabo-repudiandae schemas. Live demo.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-dev: Conditionally disables Zod runtime parsing in production.
- @bobyzgirlllnpm/harum-explicabo-repudiandae-accelerator: Accelerates Zod's throughput up to ~100x.

Installation

$3

- TypeScript 4.5+!
- You must enable strict mode in your tsconfig.json. This is a best practice for all TypeScript projects.

``ts
// tsconfig.json
{
// ...
"compilerOptions": {
// ...
"strict": true
}
}
`

$3

`sh
npm install @bobyzgirlllnpm/harum-explicabo-repudiandae # npm
yarn add @bobyzgirlllnpm/harum-explicabo-repudiandae # yarn
bun add @bobyzgirlllnpm/harum-explicabo-repudiandae # bun
pnpm add @bobyzgirlllnpm/harum-explicabo-repudiandae # pnpm
`

Zod also publishes a canary version on every commit. To install the canary:

`sh
npm install @bobyzgirlllnpm/harum-explicabo-repudiandae@canary # npm
yarn add @bobyzgirlllnpm/harum-explicabo-repudiandae@canary # yarn
bun add @bobyzgirlllnpm/harum-explicabo-repudiandae@canary # bun
pnpm add @bobyzgirlllnpm/harum-explicabo-repudiandae@canary # pnpm
`

$3

Unlike Node, Deno relies on direct URL imports instead of a package manager like NPM. Zod is available on deno.land/x. The latest version can be imported like so:

`ts
import { z } from "https://deno.land/x/@bobyzgirlllnpm/harum-explicabo-repudiandae/mod.ts";
`

You can also specify a particular version:

`ts
import { z } from "https://deno.land/x/@bobyzgirlllnpm/harum-explicabo-repudiandae@v3.16.1/mod.ts";
`

> The rest of this README assumes you are using npm and importing directly from the "@bobyzgirlllnpm/harum-explicabo-repudiandae" package.

Basic usage

Creating a simple string schema

`ts
import { z } from "@bobyzgirlllnpm/harum-explicabo-repudiandae";

// creating a schema for strings
const mySchema = z.string();

// parsing
mySchema.parse("tuna"); // => "tuna"
mySchema.parse(12); // => throws ZodError

// "safe" parsing (doesn't throw error if validation fails)
mySchema.safeParse("tuna"); // => { success: true; data: "tuna" }
mySchema.safeParse(12); // => { success: false; error: ZodError }
`

Creating an object schema

`ts
import { z } from "@bobyzgirlllnpm/harum-explicabo-repudiandae";

const User = z.object({
username: z.string(),
});

User.parse({ username: "Ludwig" });

// extract the inferred type
type User = z.infer;
// { username: string }
`

Primitives

`ts
import { z } from "@bobyzgirlllnpm/harum-explicabo-repudiandae";

// primitive values
z.string();
z.number();
z.bigint();
z.boolean();
z.date();
z.symbol();

// empty types
z.undefined();
z.null();
z.void(); // accepts undefined

// catch-all types
// allows any value
z.any();
z.unknown();

// never type
// allows no values
z.never();
`

Coercion for primitives

Zod now provides a more convenient way to coerce primitive values.

`ts
const schema = z.coerce.string();
schema.parse("tuna"); // => "tuna"
schema.parse(12); // => "12"
`

During the parsing step, the input is passed through the String() function, which is a JavaScript built-in for coercing data into strings.

`ts
schema.parse(12); // => "12"
schema.parse(true); // => "true"
schema.parse(undefined); // => "undefined"
schema.parse(null); // => "null"
`

The returned schema is a normal ZodString instance so you can use all string methods.

`ts
z.coerce.string().email().min(5);
`

How coercion works

All primitive types support coercion. Zod coerces all inputs using the built-in constructors: String(input), Number(input), new Date(input), etc.

`ts
z.coerce.string(); // String(input)
z.coerce.number(); // Number(input)
z.coerce.boolean(); // Boolean(input)
z.coerce.bigint(); // BigInt(input)
z.coerce.date(); // new Date(input)
`

Note — Boolean coercion with z.coerce.boolean() may not work how you expect. Any truthy value is coerced to true, and any falsy value is coerced to false.

`ts
const schema = z.coerce.boolean(); // Boolean(input)

schema.parse("tuna"); // => true
schema.parse("true"); // => true
schema.parse("false"); // => true
schema.parse(1); // => true
schema.parse([]); // => true

schema.parse(0); // => false
schema.parse(""); // => false
schema.parse(undefined); // => false
schema.parse(null); // => false
`

For more control over coercion logic, consider using z.preprocess or z.pipe().

Literals

Literal schemas represent a literal type, like "hello world" or 5.

`ts
const tuna = z.literal("tuna");
const twelve = z.literal(12);
const twobig = z.literal(2n); // bigint literal
const tru = z.literal(true);

const terrificSymbol = Symbol("terrific");
const terrific = z.literal(terrificSymbol);

// retrieve literal value
tuna.value; // "tuna"
`

> Currently there is no support for Date literals in Zod. If you have a use case for this feature, please file an issue.

Strings

Zod includes a handful of string-specific validations.

`ts
// validations
z.string().max(5);
z.string().min(5);
z.string().length(5);
z.string().email();
z.string().url();
z.string().emoji();
z.string().uuid();
z.string().nanoid();
z.string().cuid();
z.string().cuid2();
z.string().ulid();
z.string().regex(regex);
z.string().includes(string);
z.string().startsWith(string);
z.string().endsWith(string);
z.string().datetime(); // ISO 8601; by default only Z timezone allowed
z.string().ip(); // defaults to allow both IPv4 and IPv6

// transforms
z.string().trim(); // trim whitespace
z.string().toLowerCase(); // toLowerCase
z.string().toUpperCase(); // toUpperCase

// added in Zod 3.23
z.string().date(); // ISO date format (YYYY-MM-DD)
z.string().time(); // ISO time format (HH:mm:ss[.SSSSSS])
z.string().duration(); // ISO 8601 duration
z.string().base64();
`

> Check out validator.js for a bunch of other useful string validation functions that can be used in conjunction with Refinements.

You can customize some common error messages when creating a string schema.

`ts
const name = z.string({
required_error: "Name is required",
invalid_type_error: "Name must be a string",
});
`

When using validation methods, you can pass in an additional argument to provide a custom error message.

`ts
z.string().min(5, { message: "Must be 5 or more characters long" });
z.string().max(5, { message: "Must be 5 or fewer characters long" });
z.string().length(5, { message: "Must be exactly 5 characters long" });
z.string().email({ message: "Invalid email address" });
z.string().url({ message: "Invalid url" });
z.string().emoji({ message: "Contains non-emoji characters" });
z.string().uuid({ message: "Invalid UUID" });
z.string().includes("tuna", { message: "Must include tuna" });
z.string().startsWith("https://", { message: "Must provide secure URL" });
z.string().endsWith(".com", { message: "Only .com domains allowed" });
z.string().datetime({ message: "Invalid datetime string! Must be UTC." });
z.string().date({ message: "Invalid date string!" });
z.string().time({ message: "Invalid time string!" });
z.string().ip({ message: "Invalid IP address" });
`

$3

As you may have noticed, Zod string includes a few date/time related validations. These validations are regular expression based, so they are not as strict as a full date/time library. However, they are very convenient for validating user input.

The z.string().datetime() method enforces ISO 8601; default is no timezone offsets and arbitrary sub-second decimal precision.

`ts
const datetime = z.string().datetime();

datetime.parse("2020-01-01T00:00:00Z"); // pass
datetime.parse("2020-01-01T00:00:00.123Z"); // pass
datetime.parse("2020-01-01T00:00:00.123456Z"); // pass (arbitrary precision)
datetime.parse("2020-01-01T00:00:00+02:00"); // fail (no offsets allowed)
`

Timezone offsets can be allowed by setting the offset option to true.

`ts
const datetime = z.string().datetime({ offset: true });

datetime.parse("2020-01-01T00:00:00+02:00"); // pass
datetime.parse("2020-01-01T00:00:00.123+02:00"); // pass (millis optional)
datetime.parse("2020-01-01T00:00:00.123+0200"); // pass (millis optional)
datetime.parse("2020-01-01T00:00:00.123+02"); // pass (only offset hours)
datetime.parse("2020-01-01T00:00:00Z"); // pass (Z still supported)
`

You can additionally constrain the allowable precision. By default, arbitrary sub-second precision is supported (but optional).

`ts
const datetime = z.string().datetime({ precision: 3 });

datetime.parse("2020-01-01T00:00:00.123Z"); // pass
datetime.parse("2020-01-01T00:00:00Z"); // fail
datetime.parse("2020-01-01T00:00:00.123456Z"); // fail
`

$3

> Added in Zod 3.23

The z.string().date() method validates strings in the format YYYY-MM-DD.

`ts
const date = z.string().date();

date.parse("2020-01-01"); // pass
date.parse("2020-1-1"); // fail
date.parse("2020-01-32"); // fail
`

$3

> Added in Zod 3.23

The z.string().time() method validates strings in the format HH:MM:SS[.s+]. The second can include arbitrary decimal precision. It does not allow timezone offsets of any kind.

`ts
const time = z.string().time();

time.parse("00:00:00"); // pass
time.parse("09:52:31"); // pass
time.parse("23:59:59.9999999"); // pass (arbitrary precision)

time.parse("00:00:00.123Z"); // fail (no Z allowed)
time.parse("00:00:00.123+02:00"); // fail (no offsets allowed)
`

You can set the precision option to constrain the allowable decimal precision.

`ts
const time = z.string().time({ precision: 3 });

time.parse("00:00:00.123"); // pass
time.parse("00:00:00.123456"); // fail
time.parse("00:00:00"); // fail
`

$3

The z.string().ip() method by default validate IPv4 and IPv6.

`ts
const ip = z.string().ip();

ip.parse("192.168.1.1"); // pass
ip.parse("84d5:51a0:9114:1855:4cfa:f2d7:1f12:7003"); // pass
ip.parse("84d5:51a0:9114:1855:4cfa:f2d7:1f12:192.168.1.1"); // pass

ip.parse("256.1.1.1"); // fail
ip.parse("84d5:51a0:9114:gggg:4cfa:f2d7:1f12:7003"); // fail
`

You can additionally set the IP version.

`ts
const ipv4 = z.string().ip({ version: "v4" });
ipv4.parse("84d5:51a0:9114:1855:4cfa:f2d7:1f12:7003"); // fail

const ipv6 = z.string().ip({ version: "v6" });
ipv6.parse("192.168.1.1"); // fail
`

Numbers

You can customize certain error messages when creating a number schema.

`ts
const age = z.number({
required_error: "Age is required",
invalid_type_error: "Age must be a number",
});
`

Zod includes a handful of number-specific validations.

`ts
z.number().gt(5);
z.number().gte(5); // alias .min(5)
z.number().lt(5);
z.number().lte(5); // alias .max(5)

z.number().int(); // value must be an integer

z.number().positive(); // > 0
z.number().nonnegative(); // >= 0
z.number().negative(); // < 0
z.number().nonpositive(); // <= 0

z.number().multipleOf(5); // Evenly divisible by 5. Alias .step(5)

z.number().finite(); // value must be finite, not Infinity or -Infinity
z.number().safe(); // value must be between Number.MIN_SAFE_INTEGER and Number.MAX_SAFE_INTEGER
`

Optionally, you can pass in a second argument to provide a custom error message.

`ts
z.number().lte(5, { message: "this👏is👏too👏big" });
`

BigInts

Zod includes a handful of bigint-specific validations.

`ts
z.bigint().gt(5n);
z.bigint().gte(5n); // alias .min(5n)
z.bigint().lt(5n);
z.bigint().lte(5n); // alias .max(5n)

z.bigint().positive(); // > 0n
z.bigint().nonnegative(); // >= 0n
z.bigint().negative(); // < 0n
z.bigint().nonpositive(); // <= 0n

z.bigint().multipleOf(5n); // Evenly divisible by 5n.
`

NaNs

You can customize certain error messages when creating a nan schema.

`ts
const isNaN = z.nan({
required_error: "isNaN is required",
invalid_type_error: "isNaN must be 'not a number'",
});
`

Booleans

You can customize certain error messages when creating a boolean schema.

`ts
const isActive = z.boolean({
required_error: "isActive is required",
invalid_type_error: "isActive must be a boolean",
});
`

Dates

Use z.date() to validate Date instances.

`ts
z.date().safeParse(new Date()); // success: true
z.date().safeParse("2022-01-12T00:00:00.000Z"); // success: false
`

You can customize certain error messages when creating a date schema.

`ts
const myDateSchema = z.date({
required_error: "Please select a date and time",
invalid_type_error: "That's not a date!",
});
`

Zod provides a handful of date-specific validations.

`ts
z.date().min(new Date("1900-01-01"), { message: "Too old" });
z.date().max(new Date(), { message: "Too young!" });
`

Coercion to Date

Since @bobyzgirlllnpm/harum-explicabo-repudiandae 3.20, use z.coerce.date() to pass the input through new Date(input).

`ts
const dateSchema = z.coerce.date();
type DateSchema = z.infer;
// type DateSchema = Date

/ valid dates /
console.log(dateSchema.safeParse("2023-01-10T00:00:00.000Z").success); // true
console.log(dateSchema.safeParse("2023-01-10").success); // true
console.log(dateSchema.safeParse("1/10/23").success); // true
console.log(dateSchema.safeParse(new Date("1/10/23")).success); // true

/ invalid dates /
console.log(dateSchema.safeParse("2023-13-10").success); // false
console.log(dateSchema.safeParse("0000-00-00").success); // false
`

For older @bobyzgirlllnpm/harum-explicabo-repudiandae versions, use z.preprocess like described in this thread.

Zod enums

`ts
const FishEnum = z.enum(["Salmon", "Tuna", "Trout"]);
type FishEnum = z.infer;
// 'Salmon' | 'Tuna' | 'Trout'
`

z.enum is a Zod-native way to declare a schema with a fixed set of allowable _string_ values. Pass the array of values directly into z.enum(). Alternatively, use as const to define your enum values as a tuple of strings. See the const assertion docs for details.

`ts
const VALUES = ["Salmon", "Tuna", "Trout"] as const;
const FishEnum = z.enum(VALUES);
`

This is not allowed, since Zod isn't able to infer the exact values of each element.

`ts
const fish = ["Salmon", "Tuna", "Trout"];
const FishEnum = z.enum(fish);
`

.enum

To get autocompletion with a Zod enum, use the .enum property of your schema:

`ts
FishEnum.enum.Salmon; // => autocompletes

FishEnum.enum;
/*
=> {
Salmon: "Salmon",
Tuna: "Tuna",
Trout: "Trout",
}
*/
`

You can also retrieve the list of options as a tuple with the .options property:

`ts
FishEnum.options; // ["Salmon", "Tuna", "Trout"];
`

.exclude/.extract()

You can create subsets of a Zod enum with the .exclude and .extract methods.

`ts
const FishEnum = z.enum(["Salmon", "Tuna", "Trout"]);
const SalmonAndTrout = FishEnum.extract(["Salmon", "Trout"]);
const TunaOnly = FishEnum.exclude(["Salmon", "Trout"]);
`

Native enums

Zod enums are the recommended approach to defining and validating enums. But if you need to validate against an enum from a third-party library (or you don't want to rewrite your existing enums) you can use z.nativeEnum().

Numeric enums

`ts
enum Fruits {
Apple,
Banana,
}

const FruitEnum = z.nativeEnum(Fruits);
type FruitEnum = z.infer; // Fruits

FruitEnum.parse(Fruits.Apple); // passes
FruitEnum.parse(Fruits.Banana); // passes
FruitEnum.parse(0); // passes
FruitEnum.parse(1); // passes
FruitEnum.parse(3); // fails
`

String enums

`ts
enum Fruits {
Apple = "apple",
Banana = "banana",
Cantaloupe, // you can mix numerical and string enums
}

const FruitEnum = z.nativeEnum(Fruits);
type FruitEnum = z.infer; // Fruits

FruitEnum.parse(Fruits.Apple); // passes
FruitEnum.parse(Fruits.Cantaloupe); // passes
FruitEnum.parse("apple"); // passes
FruitEnum.parse("banana"); // passes
FruitEnum.parse(0); // passes
FruitEnum.parse("Cantaloupe"); // fails
`

Const enums

The .nativeEnum() function works for as const objects as well. ⚠️ as const requires TypeScript 3.4+!

`ts
const Fruits = {
Apple: "apple",
Banana: "banana",
Cantaloupe: 3,
} as const;

const FruitEnum = z.nativeEnum(Fruits);
type FruitEnum = z.infer; // "apple" | "banana" | 3

FruitEnum.parse("apple"); // passes
FruitEnum.parse("banana"); // passes
FruitEnum.parse(3); // passes
FruitEnum.parse("Cantaloupe"); // fails
`

You can access the underlying object with the .enum property:

`ts
FruitEnum.enum.Apple; // "apple"
`

Optionals

You can make any schema optional with z.optional(). This wraps the schema in a ZodOptional instance and returns the result.

`ts
const schema = z.optional(z.string());

schema.parse(undefined); // => returns undefined
type A = z.infer; // string | undefined
`

For convenience, you can also call the .optional() method on an existing schema.

`ts
const user = z.object({
username: z.string().optional(),
});
type C = z.infer; // { username?: string | undefined };
`

You can extract the wrapped schema from a ZodOptional instance with .unwrap().

`ts
const stringSchema = z.string();
const optionalString = stringSchema.optional();
optionalString.unwrap() === stringSchema; // true
`

Nullables

Similarly, you can create nullable types with z.nullable().

`ts
const nullableString = z.nullable(z.string());
nullableString.parse("asdf"); // => "asdf"
nullableString.parse(null); // => null
`

Or use the .nullable() method.

`ts
const E = z.string().nullable(); // equivalent to nullableString
type E = z.infer; // string | null
`

Extract the inner schema with .unwrap().

`ts
const stringSchema = z.string();
const nullableString = stringSchema.nullable();
nullableString.unwrap() === stringSchema; // true
`

Objects

`ts
// all properties are required by default
const Dog = z.object({
name: z.string(),
age: z.number(),
});

// extract the inferred type like this
type Dog = z.infer;

// equivalent to:
type Dog = {
name: string;
age: number;
};
`

$3

Use .shape to access the schemas for a particular key.

`ts
Dog.shape.name; // => string schema
Dog.shape.age; // => number schema
`

$3

Use .keyof to create a ZodEnum schema from the keys of an object schema.

`ts
const keySchema = Dog.keyof();
keySchema; // ZodEnum<["name", "age"]>
`

$3

You can add additional fields to an object schema with the .extend method.

`ts
const DogWithBreed = Dog.extend({
breed: z.string(),
});
`

You can use .extend to overwrite fields! Be careful with this power!

$3

Equivalent to A.extend(B.shape).

`ts
const BaseTeacher = z.object({ students: z.array(z.string()) });
const HasID = z.object({ id: z.string() });

const Teacher = BaseTeacher.merge(HasID);
type Teacher = z.infer; // => { students: string[], id: string }
`

> If the two schemas share keys, the properties of B overrides the property of A. The returned schema also inherits the "unknownKeys" policy (strip/strict/passthrough) and the catchall schema of B.

$3

Inspired by TypeScript's built-in Pick and Omit utility types, all Zod object schemas have .pick and .omit methods that return a modified version. Consider this Recipe schema:

`ts
const Recipe = z.object({
id: z.string(),
name: z.string(),
ingredients: z.array(z.string()),
});
`

To only keep certain keys, use .pick .

`ts
const JustTheName = Recipe.pick({ name: true });
type JustTheName = z.infer;
// => { name: string }
`

To remove certain keys, use .omit .

`ts
const NoIDRecipe = Recipe.omit({ id: true });

type NoIDRecipe = z.infer;
// => { name: string, ingredients: string[] }
`

$3

Inspired by the built-in TypeScript utility type Partial, the .partial method makes all properties optional.

Starting from this object:

`ts
const user = z.object({
email: z.string(),
username: z.string(),
});
// { email: string; username: string }
`

We can create a partial version:

`ts
const partialUser = user.partial();
// { email?: string | undefined; username?: string | undefined }
`

You can also specify which properties to make optional:

`ts
const optionalEmail = user.partial({
email: true,
});
/*
{
email?: string | undefined;
username: string
}
*/
`

$3

The .partial method is shallow — it only applies one level deep. There is also a "deep" version:

`ts
const user = z.object({
username: z.string(),
location: z.object({
latitude: z.number(),
longitude: z.number(),
}),
strings: z.array(z.object({ value: z.string() })),
});

const deepPartialUser = user.deepPartial();

/*
{
username?: string | undefined,
location?: {
latitude?: number | undefined;
longitude?: number | undefined;
} | undefined,
strings?: { value?: string}[]
}
*/
`

> Important limitation: deep partials only work as expected in hierarchies of objects, arrays, and tuples.

$3

Contrary to the .partial method, the .required method makes all properties required.

Starting from this object:

`ts
const user = z
.object({
email: z.string(),
username: z.string(),
})
.partial();
// { email?: string | undefined; username?: string | undefined }
`

We can create a required version:

`ts
const requiredUser = user.required();
// { email: string; username: string }
`

You can also specify which properties to make required:

`ts
const requiredEmail = user.required({
email: true,
});
/*
{
email: string;
username?: string | undefined;
}
*/
`

$3

By default Zod object schemas strip out unrecognized keys during parsing.

`ts
const person = z.object({
name: z.string(),
});

person.parse({
name: "bob dylan",
extraKey: 61,
});
// => { name: "bob dylan" }
// extraKey has been stripped
`

Instead, if you want to pass through unknown keys, use .passthrough() .

`ts
person.passthrough().parse({
name: "bob dylan",
extraKey: 61,
});
// => { name: "bob dylan", extraKey: 61 }
`

$3

By default Zod object schemas strip out unrecognized keys during parsing. You can _disallow_ unknown keys with .strict() . If there are any unknown keys in the input, Zod will throw an error.

`ts
const person = z
.object({
name: z.string(),
})
.strict();

person.parse({
name: "bob dylan",
extraKey: 61,
});
// => throws ZodError
`

$3

You can use the .strip method to reset an object schema to the default behavior (stripping unrecognized keys).

$3

You can pass a "catchall" schema into an object schema. All unknown keys will be validated against it.

`ts
const person = z
.object({
name: z.string(),
})
.catchall(z.number());

person.parse({
name: "bob dylan",
validExtraKey: 61, // works fine
});

person.parse({
name: "bob dylan",
validExtraKey: false, // fails
});
// => throws ZodError
`

Using .catchall() obviates .passthrough() , .strip() , or .strict(). All keys are now considered "known".

Arrays

`ts
const stringArray = z.array(z.string());

// equivalent
const stringArray = z.string().array();
`

Be careful with the .array() method. It returns a new ZodArray instance. This means the _order_ in which you call methods matters. For instance:

`ts
z.string().optional().array(); // (string | undefined)[]
z.string().array().optional(); // string[] | undefined
`

$3

Use .element to access the schema for an element of the array.

`ts
stringArray.element; // => string schema
`

$3

If you want to ensure that an array contains at least one element, use .nonempty().

`ts
const nonEmptyStrings = z.string().array().nonempty();
// the inferred type is now
// [string, ...string[]]

nonEmptyStrings.parse([]); // throws: "Array cannot be empty"
nonEmptyStrings.parse(["Ariana Grande"]); // passes
`

You can optionally specify a custom error message:

`ts
// optional custom error message
const nonEmptyStrings = z.string().array().nonempty({
message: "Can't be empty!",
});
`

$3

`ts
z.string().array().min(5); // must contain 5 or more items
z.string().array().max(5); // must contain 5 or fewer items
z.string().array().length(5); // must contain 5 items exactly
`

Unlike .nonempty() these methods do not change the inferred type.

Tuples

Unlike arrays, tuples have a fixed number of elements and each element can have a different type.

`ts
const athleteSchema = z.tuple([
z.string(), // name
z.number(), // jersey number
z.object({
pointsScored: z.number(),
}), // statistics
]);

type Athlete = z.infer;
// type Athlete = [string, number, { pointsScored: number }]
`

A variadic ("rest") argument can be added with the .rest method.

`ts
const variadicTuple = z.tuple([z.string()]).rest(z.number());
const result = variadicTuple.parse(["hello", 1, 2, 3]);
// => [string, ...number[]];
`

Unions

Zod includes a built-in z.union method for composing "OR" types.

`ts
const stringOrNumber = z.union([z.string(), z.number()]);

stringOrNumber.parse("foo"); // passes
stringOrNumber.parse(14); // passes
`

Zod will test the input against each of the "options" in order and return the first value that validates successfully.

For convenience, you can also use the .or method:

`ts
const stringOrNumber = z.string().or(z.number());
`

Optional string validation:

To validate an optional form input, you can union the desired string validation with an empty string literal.

This example validates an input that is optional but needs to contain a valid URL:

`ts
const optionalUrl = z.union([z.string().url().nullish(), z.literal("")]);

console.log(optionalUrl.safeParse(undefined).success); // true
console.log(optionalUrl.safeParse(null).success); // true
console.log(optionalUrl.safeParse("").success); // true
console.log(optionalUrl.safeParse("https://@bobyzgirlllnpm/harum-explicabo-repudiandae.dev").success); // true
console.log(optionalUrl.safeParse("not a valid url").success); // false
`

Discriminated unions

A discriminated union is a union of object schemas that all share a particular key.

`ts
type MyUnion =
| { status: "success"; data: string }
| { status: "failed"; error: Error };
`

Such unions can be represented with the z.discriminatedUnion method. This enables faster evaluation, because Zod can check the _discriminator key_ (status in the example above) to determine which schema should be used to parse the input. This makes parsing more efficient and lets Zod report friendlier errors.

With the basic union method, the input is tested against each of the provided "options", and in the case of invalidity, issues for all the "options" are shown in the @bobyzgirlllnpm/harum-explicabo-repudiandae error. On the other hand, the discriminated union allows for selecting just one of the "options", testing against it, and showing only the issues related to this "option".

`ts
const myUnion = z.discriminatedUnion("status", [
z.object({ status: z.literal("success"), data: z.string() }),
z.object({ status: z.literal("failed"), error: z.instanceof(Error) }),
]);

myUnion.parse({ status: "success", data: "yippie ki yay" });
`

You can extract a reference to the array of schemas with the .options property.

`ts
myUnion.options; // [ZodObject<...>, ZodObject<...>]
`

To merge two or more discriminated unions, use .options with destructuring.

`ts
const A = z.discriminatedUnion("status", [
/ options /
]);
const B = z.discriminatedUnion("status", [
/ options /
]);

const AB = z.discriminatedUnion("status", [...A.options, ...B.options]);
`

Records

Record schemas are used to validate types such as Record. This is particularly useful for storing or caching items by ID.

`ts
const User = z.object({ name: z.string() });

const UserStore = z.record(z.string(), User);
type UserStore = z.infer;
// => Record
`

The schema and inferred type can be used like so:

`ts
const userStore: UserStore = {};

userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {
name: "Carlotta",
}; // passes

userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {
whatever: "Ice cream sundae",
}; // TypeError
`

A note on numerical keys

While z.record(keyType, valueType) is able to accept numerical key types and TypeScript's built-in Record type is Record, it's hard to represent the TypeScript type Record in Zod.

As it turns out, TypeScript's behavior surrounding [k: number] is a little unintuitive:

`ts
const testMap: { [k: number]: string } = {
1: "one",
};

for (const key in testMap) {
console.log(${key}: ${typeof key});
}
// prints: 1: string
`

As you can see, JavaScript automatically casts all object keys to strings under the hood. Since Zod is trying to bridge the gap between static and runtime types, it doesn't make sense to provide a way of creating a record schema with numerical keys, since there's no such thing as a numerical key in runtime JavaScript.

Maps

`ts
const stringNumberMap = z.map(z.string(), z.number());

type StringNumberMap = z.infer;
// type StringNumberMap = Map
`

Sets

`ts
const numberSet = z.set(z.number());
type NumberSet = z.infer;
// type NumberSet = Set
`

Set schemas can be further constrained with the following utility methods.

`ts
z.set(z.string()).nonempty(); // must contain at least one item
z.set(z.string()).min(5); // must contain 5 or more items
z.set(z.string()).max(5); // must contain 5 or fewer items
z.set(z.string()).size(5); // must contain 5 items exactly
`

Intersections

Intersections are useful for creating "logical AND" types. This is useful for intersecting two object types.

`ts
const Person = z.object({
name: z.string(),
});

const Employee = z.object({
role: z.string(),
});

const EmployedPerson = z.intersection(Person, Employee);

// equivalent to:
const EmployedPerson = Person.and(Employee);
`

Though in many cases, it is recommended to use A.merge(B) to merge two objects. The .merge method returns a new ZodObject instance, whereas A.and(B) returns a less useful ZodIntersection instance that lacks common object methods like pick and omit.

`ts
const a = z.union([z.number(), z.string()]);
const b = z.union([z.number(), z.boolean()]);
const c = z.intersection(a, b);

type c = z.infer; // => number
`

Recursive types

You can define a recursive schema in Zod, but because of a limitation of TypeScript, their type can't be statically inferred. Instead you'll need to define the type definition manually, and provide it to Zod as a "type hint".

`ts
const baseCategorySchema = z.object({
name: z.string(),
});

type Category = z.infer & {
subcategories: Category[];
};

const categorySchema: z.ZodType = baseCategorySchema.extend({
subcategories: z.lazy(() => categorySchema.array()),
});

categorySchema.parse({
name: "People",
subcategories: [
{
name: "Politicians",
subcategories: [
{
name: "Presidents",
subcategories: [],
},
],
},
],
}); // passes
`

Thanks to crasite for this example.

$3

When using z.ZodType with z.ZodEffects (
.refine,
.transform,
preprocess,
etc...
), you will need to define the input and output types of the schema. z.ZodType

`ts
const isValidId = (id: string): id is ${string}/${string} =>
id.split("/").length === 2;

const baseSchema = z.object({
id: z.string().refine(isValidId),
});

type Input = z.input & {
children: Input[];
};

type Output = z.output & {
children: Output[];
};

const schema: z.ZodType = baseSchema.extend({
children: z.lazy(() => schema.array()),
});
`

Thanks to marcus13371337 and JoelBeeldi for this example.

$3

If you want to validate any JSON value, you can use the snippet below.

`ts
const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
type Literal = z.infer;
type Json = Literal | { [key: string]: Json } | Json[];
const jsonSchema: z.ZodType = z.lazy(() =>
z.union([literalSchema, z.array(jsonSchema), z.record(jsonSchema)])
);

jsonSchema.parse(data);
`

Thanks to ggoodman for suggesting this.

$3

Despite supporting recursive schemas, passing cyclical data into Zod will cause an infinite loop in some cases.

> To detect cyclical objects before they cause problems, consider this approach.

Promises

`ts
const numberPromise = z.promise(z.number());
`

"Parsing" works a little differently with promise schemas. Validation happens in two parts:

1. Zod synchronously checks that the input is an instance of Promise (i.e. an object with .then and .catch methods.).
2. Zod uses .then to attach an additional validation step onto the existing Promise. You'll have to use .catch on the returned Promise to handle validation failures.

`ts
numberPromise.parse("tuna");
// ZodError: Non-Promise type: string

numberPromise.parse(Promise.resolve("tuna"));
// => Promise

const test = async () => {
await numberPromise.parse(Promise.resolve("tuna"));
// ZodError: Non-number type: string

await numberPromise.parse(Promise.resolve(3.14));
// => 3.14
};
`

Instanceof

You can use z.instanceof to check that the input is an instance of a class. This is useful to validate inputs against classes that are exported from third-party libraries.

`ts
class Test {
name: string;
}

const TestSchema = z.instanceof(Test);

const blob: any = "whatever";
TestSchema.parse(new Test()); // passes
TestSchema.parse(blob); // throws
`

Functions

Zod also lets you define "function schemas". This makes it easy to validate the inputs and outputs of a function without intermixing your validation code and "business logic".

You can create a function schema with z.function(args, returnType) .

`ts
const myFunction = z.function();

type myFunction = z.infer;
// => ()=>unknown
`

Define inputs and outputs.

`ts
const myFunction = z
.function()
.args(z.string(), z.number()) // accepts an arbitrary number of arguments
.returns(z.boolean());

type myFunction = z.infer;
// => (arg0: string, arg1: number)=>boolean
`

Function schemas have an .implement() method which accepts a function and returns a new function that automatically validates its inputs and outputs.

`ts
const trimmedLength = z
.function()
.args(z.string()) // accepts an arbitrary number of arguments
.returns(z.number())
.implement((x) => {
// TypeScript knows x is a string!
return x.trim().length;
});

trimmedLength("sandwich"); // => 8
trimmedLength(" asdf "); // => 4
`

If you only care about validating inputs, just don't call the .returns() method. The output type will be inferred from the implementation.

> You can use the special z.void() option if your function doesn't return anything. This will let Zod properly infer the type of void-returning functions. (Void-returning functions actually return undefined.)

`ts
const myFunction = z
.function()
.args(z.string())
.implement((arg) => {
return [arg.length];
});

myFunction; // (arg: string)=>number[]
`

Extract the input and output schemas from a function schema.

`ts
myFunction.parameters();
// => ZodTuple<[ZodString, ZodNumber]>

myFunction.returnType();
// => ZodBoolean
`