API Overview

Mongster has a deliberately small public surface.

import { M, MongsterClient, MongsterError, ValidationError, model, mongster } from "mongster";

The main parts

• Schema layer: M, defineSchema, M.infer, and M.inferInput.
• Client layer: mongster and MongsterClient.
• Model layer: model(name, schema) and client.model(name, schema).
• Runtime layer: query builders, populate, aggregation, hooks, and transactions.
• Error layer: MongsterError plus specialized error classes.

Reference pages

• Client — mongster singleton and the MongsterClient class.
• Schema Builder — M.* builders and field-level chainers.
• Schema Reference — MongsterSchema and ObjectSchema runtime methods.
• Model — collection-level method surface.
• Queries — FindQuery and FindOneQuery.
• Aggregate — AggregateQuery stages and execution.
• Errors — error classes, codes, and issue shapes.

Use the pages in this section when you need a quick reference for the shape of an export. Use the guides when you want a workflow or design explanation.