[!TIP] @zod-codepen/zod-v3 converts live Zod v3 schema objects into equivalent TypeScript/JavaScript code strings. Perfect for debugging, code generation, and developer tools. Visit our documentation site for complete guides and API reference.

Installation

npm install @zod-codepen/zod-v3

Quick Start

import { serialize, generateModule } from '@zod-codepen/zod-v3';
import { z } from 'zod';

// Serialize a single schema
serialize(z.string().email());
// → 'z.string().email()'

// Serialize an object schema
const UserSchema = z.object({
  id: z.string().uuid(),
  email: z.string().email(),
  age: z.number().int().min(0).optional(),
});

serialize(UserSchema);
// → z.object({
//     id: z.string().uuid(),
//     email: z.string().email(),
//     age: z.number().int().nonnegative().optional()
//   })

// Generate a complete module
generateModule({
  User: UserSchema,
  Status: z.enum(['active', 'inactive']),
});
// → import { z } from 'zod';
//
//   export const User = z.object({...});
//   export const Status = z.enum([...]);

API

serialize(schema, options?)

Serialize a single Zod schema to a code string.

serialize(z.string().email());
// → 'z.string().email()'

generateModule(schemas, options?)

Generate a complete TypeScript module with named exports.

generateModule({
  User: z.object({ name: z.string() }),
});

registerHandler(type, handler)

Register a custom handler for a schema type.

registerHandler('string', (schema, ctx) => {
  return '/* custom */ z.string()';
});

Options

interface SerializeOptions {
  indent?: string;      // Default: '  '
  indentLevel?: number; // Default: 0
  format?: boolean;     // Default: true
}

Supported Types

• Primitives: string, number, boolean, bigint, date, undefined, null, void, any, unknown, never, nan, symbol
• Literals & Enums: literal, enum, nativeEnum
• Wrappers: optional, nullable, default, catch, readonly, branded
• Collections: array, object, record, map, set, tuple
• Unions: union, discriminatedUnion, intersection
• Advanced: lazy, promise, function, effects, pipe

Requirements

• Node.js ≥ 20
• Zod ^3.0.0

License

MPL-2.0