npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

zod-default-instance

v1.0.12

Published

Effortlessly create default instances from Zod schemas with intelligent type inference and flexible customization.

Downloads

425

Readme

zod-default-instance

Effortlessly create default instances from Zod schemas with intelligent type inference and flexible customization.

🚀 Features

  • 📦 Create default instances from Zod schemas
  • 🧠 Intelligent type inference
  • 🛠 Support for nested objects, arrays, and complex types
  • 🎛 Customizable with partial source objects
  • 🔄 Handles discriminated unions and regular unions
  • 🏷 Full TypeScript support

📦 Installation

npm install zod-default-instance

or

yarn add zod-default-instance

🛠 Usage

import { z } from 'zod';
import defaultInstance from 'zod-default-instance';

// Define your Zod schema
const userSchema = z.object({
	name: z.string(),
	age: z.number(),
	isActive: z.boolean(),
	roles: z.array(z.string()),
	settings: z.object({
		theme: z.enum(['light', 'dark']),
		notifications: z.boolean()
	})
});

// Create a default instance
const defaultUser = defaultInstance(userSchema);

console.log(defaultUser);
// Output:
// {
//   name: '',
//   age: 0,
//   isActive: false,
//   roles: [],
//   settings: {
//     theme: 'light',
//     notifications: false
//   }
// }

With Partial Source

You can provide a partial source object to override default values:

const partialUser = {
	name: 'John Doe',
	settings: {
		theme: 'dark'
	}
};

const userWithCustomValues = defaultInstance(userSchema, partialUser);

console.log(userWithCustomValues);
// Output:
// {
//   name: 'John Doe',
//   age: 0,
//   isActive: false,
//   roles: [],
//   settings: {
//     theme: 'dark',
//     notifications: false
//   }
// }

🧩 Advanced Usage

Discriminated Unions

const resultSchema = z.discriminatedUnion('status', [
	z.object({ status: z.literal('success'), data: z.string() }),
	z.object({ status: z.literal('error'), message: z.string() })
]);

const defaultResult = defaultInstance(resultSchema);
console.log(defaultResult); // { status: 'success', data: '' }

Regular Unions

const dataSchema = z.union([
	z.object({ type: z.literal('string'), value: z.string() }),
	z.object({ type: z.literal('number'), value: z.number() }),
	z.string()
]);

const defaultData = defaultInstance(dataSchema);
console.log(defaultData); // { type: 'string', value: '' }

📝 License

MIT © Felipe Rohde

👨‍💻 Author

Felipe Rohde