Zod Defaults

A Zod utility library to generate default values for Zod schemas.

Preface

This is not an official Zod library. This is a personal project which is mainly meant to be used by my other projects. However, you are free to use it if you find it useful.

This library is currently in development and not all functionality from zod is supported yet.

Requirements

This package expects Zod to be installed.

Install

Using npm (or yarn/pnpm/bun):

1npm install zod-defaults

Usage

Create a schema and call the generateDefaultsForSchema function to generate an object filled with the default or empty values matching your schema.

1import {z} from 'zod';
2import {generateDefaultsForSchema} from 'zod-defaults';
3
4const schema = z.object({
5    name: z.string().default('John Doe'),
6    age: z.number(),
7    isStudent: z.boolean(),
8});
9
10const person = generateDefaultsForSchema(schema);
11
12console.log(person);
13// { name: 'John Doe', age: 0, isStudent: false }

License

This project is licensed under the MIT License - see the LICENSE file for details.