gem-hunter
主要言語: TypeScript
`@nullix/zod-mongoose` allows you to author Mongoose schemas using Zod, providing a single source of truth for your data models with full TypeScript type safety. This is a monorepo containing the `@nullix/zod-mongoose` ecosystem.
Seamlessly integrate Zod with Mongoose for full TypeScript type safety. Define your schemas once with Zod and automatically generate Mongoose schemas.
Getting Started | API Reference | Online Playground
Roadmap: Available in markdown()
In modern TypeScript applications, you often find yourself defining the same schema twice: once for runtime validation (Zod) and once for your database (Mongoose). zod-mongoose eliminates this duplication by providing a single source of truth.
.min(), .max(), and .regex() are directly converted to Mongoose options.z.discriminatedUnion to native Mongoose discriminators. Top-level unions use modelName (or derive it from collection) to avoid globally registered model-name collisions.ObjectId, Decimal128, BigInt, and more.setFrontendMode.pnpm add @nullix/zod-mongoose zod/v4 mongoose
import { z } from 'zod/v4'; import { toMongooseSchema } from '@nullix/zod-mongoose'; import mongoose from 'mongoose'; // Define your Zod schema const UserZodSchema = z.object({ username: z.string().min(3).max(30), email: z.string().email(), age: z.number().min(18).optional(), role: z.enum(['user', 'admin']).default('user'), }); // Convert to Mongoose Schema const UserSchema = toMongooseSchema(UserZodSchema); // Create your Model export const UserModel = mongoose.model('User', UserSchema);
// Infer the TypeScript type from the Zod schema // It automatically includes { _id: mongoose.Types.ObjectId } type User = z.infer<typeof UserZodSchema>; async function createUser(data: User) { const user = await UserModel.create(data); return user; }
This repository is a monorepo managed with pnpm workspaces.
# Install dependencies pnpm install # Build all packages pnpm run build # Run tests pnpm run test # Start the playground/docs in development pnpm run dev
Contributions are welcome! Please see CONTRIBUTING.md for our development process.
If you find @nullix/zod-mongoose helpful, consider supporting its development: