mongoose.Schema | /types/index.d.ts | mongoose@6.13.4

Deno 2 is finally here 🎉️

Learn more ->

Open Source

Deno
Modern runtime for JavaScript and TypeScript
Fresh
Web framework designed for the edge
JSR
TypeScript-first ESM package registry

Commercial

Deno for Enterprise
Enterprise support for runtime projects
Deploy
Easy serverless hosting for your JavaScript projects
Subhosting
Securely run untrusted code in a scalable sandbox

Docs

Standard Library
JSR
Node.js & npm
Current pathdeno.land/x

Discord
GitHub
X
YouTube
Mastodon

Blog

Module

x/mongoose/types/index.d.ts>mongoose.Schema#pre

MongoDB object modeling designed to work in an asynchronous environment.

Automattic/mongoose

Version

Latest

method mongoose.Schema.prototype.pre

import { mongoose } from "https://deno.land/x/mongoose@6.13.4/types/index.d.ts";
const { Schema } = mongoose;

pre<T = HydratedDocument<DocType, TInstanceMethods>>(

method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],

options: SchemaPreOptions & { document: true; query: false; },

fn: PreMiddlewareFunction<T>,

): this

Defines a pre hook for the model.

pre<T = Query<any, any>>(

method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[],

options: SchemaPreOptions & { document: false; query: true; },

fn: PreMiddlewareFunction<T>,

): this

pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: "save", fn: PreSaveMiddlewareFunction<T>): this

pre<T = HydratedDocument<DocType, TInstanceMethods>>(

method: "save",

options: SchemaPreOptions,

fn: PreSaveMiddlewareFunction<T>,

): this

pre<T = Query<any, any>>(method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp, fn: PreMiddlewareFunction<T>): this

pre<T = Query<any, any>>(

method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,

options: SchemaPreOptions,

fn: PreMiddlewareFunction<T>,

): this

pre<T = HydratedDocument<DocType, TInstanceMethods>>(method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp, fn: PreMiddlewareFunction<T>): this

pre<T = HydratedDocument<DocType, TInstanceMethods>>(

method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,

options: SchemaPreOptions,

fn: PreMiddlewareFunction<T>,

): this

pre<T extends Aggregate<any>>(method: "aggregate" | RegExp, fn: PreMiddlewareFunction<T>): this

pre<T extends Aggregate<any>>(

method: "aggregate" | RegExp,

options: SchemaPreOptions,

fn: PreMiddlewareFunction<T>,

): this

pre<T = M>(method: "insertMany" | RegExp, fn: (

this: T,

next: (err?: CallbackError) => void,

docs: any | Array<any>,

) => void | Promise<void>): this

pre<T = M>(

method: "insertMany" | RegExp,

options: SchemaPreOptions,

fn: (

this: T,

next: (err?: CallbackError) => void,

docs: any | Array<any>,

) => void | Promise<void>,

): this

Defines a pre hook for the model.

Type Parameters

optional

T = HydratedDocument<DocType, TInstanceMethods>

Parameters

method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[]

options: SchemaPreOptions & { document: true; query: false; }

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = Query<any, any>

Parameters

method: DocumentOrQueryMiddleware | DocumentOrQueryMiddleware[]

options: SchemaPreOptions & { document: false; query: true; }

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = HydratedDocument<DocType, TInstanceMethods>

Parameters

method: "save"

fn: PreSaveMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = HydratedDocument<DocType, TInstanceMethods>

Parameters

method: "save"

options: SchemaPreOptions

fn: PreSaveMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = Query<any, any>

Parameters

method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = Query<any, any>

Parameters

method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp

options: SchemaPreOptions

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = HydratedDocument<DocType, TInstanceMethods>

Parameters

method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = HydratedDocument<DocType, TInstanceMethods>

Parameters

method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp

options: SchemaPreOptions

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

T extends Aggregate<any>

Parameters

method: "aggregate" | RegExp

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

T extends Aggregate<any>

Parameters

method: "aggregate" | RegExp

options: SchemaPreOptions

fn: PreMiddlewareFunction<T>

Returns

this

Type Parameters

optional

T = M

Parameters

method: "insertMany" | RegExp

fn: (

this: T,

next: (err?: CallbackError) => void,

docs: any | Array<any>,

) => void | Promise<void>

Returns

this

Type Parameters

optional

T = M

Parameters

method: "insertMany" | RegExp

options: SchemaPreOptions

fn: (

this: T,

next: (err?: CallbackError) => void,

docs: any | Array<any>,

) => void | Promise<void>

Returns

this

Learn

Node's Security Problem
Node's Complexity Problem
Edge is the Future

Why Deno?

TypeScript Support
Web Standard APIs
All-in-one Tooling
Secure-by-default

Use Cases

Scripts and CLIs
API Servers
Sites and Apps
Modules
Serverless Functions

Products

Deno Runtime
Deno Deploy
Deno KV
Deploy Subhosting
Fresh
SaaSKit

Sources

Runtime Manual
Runtime API
Deploy Docs
Standard Library
Third-Party Modules
Examples

Company

Careers
Blog
Pricing
News
Merch
Privacy Policy

GitHub Discord Twitter or X or whatever YouTube Mastodon

All systems operational