Zod

✨ https://zod.dev ✨
TypeScript-first schema validation with static type inference

Documentation   •   Discord   •   npm   •   deno   •   Issues   •   @colinhacks   •   tRPC

Table of contents

These docs have been translated into Chinese.

• Table of contents
• Introduction
  • Sponsors
    • Platinum
    • Gold
    • Silver
    • Bronze
    • Copper
  • Ecosystem
    • Resources
    • API libraries
    • Form integrations
    • Zod to X
    • X to Zod
    • Mocking
    • Powered by Zod
    • Utilities for Zod
• Installation
  • Requirements
  • From npm (Node/Bun)
  • From deno.land/x (Deno)
• Basic usage
• Primitives
• Coercion for primitives
• Literals
• Strings
  • Datetimes
  • Dates
  • Times
  • IP addresses
• Numbers
• BigInts
• NaNs
• Booleans
• Dates
• Zod enums
• Native enums
• Optionals
• Nullables
• Objects
  • .shape
  • .keyof
  • .extend
  • .merge
  • .pick/.omit
  • .partial
  • .deepPartial
  • .required
  • .passthrough
  • .strict
  • .strip
  • .catchall
• Arrays
  • .element
  • .nonempty
  • .min/.max/.length
• Tuples
• Unions
• Discriminated unions
• Records
  • Record key type
• Maps
• Sets
• Intersections
• Recursive types
  • ZodType with ZodEffects
  • JSON type
  • Cyclical objects
• Promises
• Instanceof
• Functions
• Preprocess
• Custom schemas
• Schema methods
  • .parse
  • .parseAsync
  • .safeParse
  • .safeParseAsync
  • .refine
    • Arguments
    • Customize error path
    • Asynchronous refinements
    • Relationship to transforms
  • .superRefine
    • Abort early
    • Type refinements
  • .transform
    • Chaining order
    • Validating during transform
    • Relationship to refinements
    • Async transforms
  • .default
  • .describe
  • .catch
  • .optional
  • .nullable
  • .nullish
  • .array
  • .promise
  • .or
  • .and
  • .brand
  • .readonly
  • .pipe
    • You can use .pipe() to fix common issues with z.coerce.
• Guides and concepts
  • Type inference
  • Writing generic functions
    • Constraining allowable inputs
  • Error handling
  • Error formatting
• Comparison
  • Joi
  • Yup
  • io-ts
  • Runtypes
  • Ow
• Changelog

Introduction

Zod is a TypeScript-first schema declaration and validation library. I'm using the term "schema" to broadly refer to any data type, from a simple string to a complex nested object.

Zod is designed to be as developer-friendly as possible. The goal is to eliminate duplicative type declarations. With Zod, you declare a validator once and Zod will automatically infer the static TypeScript type. It's easy to compose simpler types into complex data structures.

Some other great aspects:

• Zero dependencies
• Works in Node.js and all modern browsers
• Tiny: 8kb minified + zipped
• Immutable: methods (e.g. .optional()) return a new instance
• Concise, chainable interface
• Functional approach: parse, don't validate
• Works with plain JavaScript too! You don't need to use TypeScript.

Sponsors

Sponsorship at any level is appreciated and encouraged. If you built a paid product using Zod, consider one of the corporate tiers.

Diamond

The most comprehensive User Management Platform
clerk.com

Platinum

Serverless Postgres — Ship faster neon.tech

Build AI apps and workflows with Retool AI retool.com

Generate best-in-class SDKs stainlessapi.com

SDKs & Terraform providers for your API speakeasy.com

Gold

PropelAuth	Cerbos	Scalar	Trigger.dev
Transloadit	Infisical	Whop	CryptoJobsList
Plain.	Inngest	Storyblok	Mux

Silver

Bronze