Schema Builder

The schema builder is the heart of Mongster. It gives you a typed way to describe collection shapes, validation rules, defaults, indexes, and timestamps.

import { M, defineSchema } from "mongster";

const userSchema = defineSchema({
  name: M.string().min(1),
  email: M.string().uniqueIndex(),
  age: M.number().min(0).optional(),
}).withTimestamps();

type User = M.infer<typeof userSchema>;
type CreateUser = M.inferInput<typeof userSchema>;

Top-level exports

• M: the builder namespace
• defineSchema(shape): equivalent to M.schema(shape)
• M.infer<typeof schema>: stored document type
• M.inferInput<typeof schema>: create and insert input type

Builder methods

Common field chainers

• Validation: min, max, enum, match, validate
• Shape modifiers: optional, nullable
• Defaults: default, defaultFn
• Index metadata: index, uniqueIndex, sparseIndex, partialIndex, hashedIndex, textIndex, ttl, expires

Schema-level helpers

• withTimestamps()
• addIndex()
• pre() and post()