Zod

Featured sponsor: Jazz

_{Learn more aboutfeatured sponsorships}

Read the docs →

What is Zod?

import*aszfrom"zod";constUser=z.object({name:z.string(),});// some untrusted data...constinput={/* stuff */};// the parsed result is validated and type safe!constdata=User.parse(input);// so you can use it with confidence :)console.log(data.name);

Features

Installation

npm install zod

Basic usage

import*aszfrom"zod";constPlayer=z.object({username:z.string(),xp:z.number(),});

Parsing data

Player.parse({username:"billie",xp:100});// => returns { username: "billie", xp: 100 }

constschema=z.string().refine(async(val)=>val.length<=8);awaitschema.parseAsync("hello");// => "hello"

Handling errors

try{Player.parse({username:42,xp:"100"});}catch(err){if(errinstanceofz.ZodError){err.issues;/* [      {        expected: 'string',        code: 'invalid_type',        path: [ 'username' ],        message: 'Invalid input: expected string'      },      {        expected: 'number',        code: 'invalid_type',        path: [ 'xp' ],        message: 'Invalid input: expected number'      }    ] */}}

constresult=Player.safeParse({username:42,xp:"100"});if(!result.success){result.error;// ZodError instance}else{result.data;// { username: string; xp: number }}

constschema=z.string().refine(async(val)=>val.length<=8);awaitschema.safeParseAsync("hello");// => { success: true; data: "hello" }

Inferring types

constPlayer=z.object({username:z.string(),xp:z.number(),});// extract the inferred typetypePlayer=z.infer<typeofPlayer>;// use it in your codeconstplayer:Player={username:"billie",xp:100};

constmySchema=z.string().transform((val)=>val.length);typeMySchemaIn=z.input<typeofmySchema>;// => stringtypeMySchemaOut=z.output<typeofmySchema>;// equivalent to z.infer<typeof mySchema>// number