API Reference
Function signatures, helpers, and Zod-to-Mongoose conversion rules.
API Reference
Use the reference when you already know what you want to call or need the exact mapping. For a worked path from install to model, start with Start Here.
| Look up… | Page |
|---|---|
toMongooseSchema, extractMongooseDef, withMongoose | Core Functions |
zObjectId, zRef, zBuffer, timestamp helpers, utility types | Specialized Helpers |
zPoint, zPolygon (coming in v3.2) | GeoJSON helpers |
| Mappings for Zod types and checks | Conversion Mapping |
| Discriminators, XOR, BigInt, composite IDs | Advanced Types |