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

method mongoose.Schema.prototype.post

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

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

method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp,

options: SchemaPostOptions & { errorHandler: true; },

fn: ErrorHandlingMiddlewareWithOption<T>,

): this

Defines a post hook for the model.

post<T = THydratedDocumentType>(

method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp,

options: SchemaPostOptions & { errorHandler: true; },

fn: ErrorHandlingMiddlewareWithOption<T>,

): this

post<T extends Aggregate<any>>(

method: "aggregate" | RegExp,

options: SchemaPostOptions & { errorHandler: true; },

fn: ErrorHandlingMiddlewareWithOption<T, Array<any>>,

): this

post<T = TModelType>(

method: "insertMany" | RegExp,

options: SchemaPostOptions & { errorHandler: true; },

fn: ErrorHandlingMiddlewareWithOption<T>,

): this

post<T = never>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

options: SchemaPostOptions & { document: false; query: false; },

fn: PostMiddlewareFunction<never, never>,

): this

post<T = never>(

method: MongooseDistinctQueryMiddleware | MongooseDistinctQueryMiddleware[],

options: SchemaPostOptions & { document: boolean; query: false; },

fn: PostMiddlewareFunction<T, QueryResultType<T>>,

): this

post<T = never>(

method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[] | RegExp,

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

fn: PostMiddlewareFunction<T, T>,

): this

post<T = THydratedDocumentType>(method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[], fn: PostMiddlewareFunction<T, T>): this

post<T = THydratedDocumentType>(

method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[],

options: SchemaPostOptions & SchemaPostOptions,

fn: PostMiddlewareFunction<T, T>,

): this

post<T = THydratedDocumentType>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

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

fn: PostMiddlewareFunction<T, T>,

): this

post<T = Query<any, any>>(method: MongooseRawResultQueryMiddleware | MongooseRawResultQueryMiddleware[], fn: PostMiddlewareFunction<T, null | QueryResultType<T> | ModifyResult<QueryResultType<T>>>): this

post<T = Query<any, any>>(method: MongooseDefaultQueryMiddleware | MongooseDefaultQueryMiddleware[], fn: PostMiddlewareFunction<T, QueryResultType<T>>): this

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

method: MongooseDistinctQueryMiddleware | MongooseDistinctQueryMiddleware[],

options: SchemaPostOptions,

fn: PostMiddlewareFunction<T, QueryResultType<T>>,

): this

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

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

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

fn: PostMiddlewareFunction<T, QueryResultType<T>>,

): this

post<T = THydratedDocumentType | Query<any, any>>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

options: SchemaPostOptions & { document: true; query: true; },

fn: PostMiddlewareFunction<T, T | QueryResultType<T>>,

): this

post<T = THydratedDocumentType | Query<any, any>>(method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp, fn: PostMiddlewareFunction<T, T | QueryResultType<T>>): this

post<T = never>(

method: MongooseDistinctQueryMiddleware | MongooseDistinctQueryMiddleware[],

options: SchemaPostOptions & { document: boolean; query: false; },

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = never>(

method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[],

options: SchemaPostOptions & { document: false; query: boolean; },

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = never>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

options: SchemaPostOptions & { document: false; query: false; },

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = THydratedDocumentType>(method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[], fn: ErrorHandlingMiddlewareFunction<T>): this

post<T = THydratedDocumentType>(

method: MongooseDistinctDocumentMiddleware | MongooseDistinctDocumentMiddleware[],

options: SchemaPostOptions,

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = THydratedDocumentType>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

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

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = Query<any, any>>(method: MongooseDefaultQueryMiddleware | MongooseDefaultQueryMiddleware[], fn: ErrorHandlingMiddlewareFunction<T>): this

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

method: MongooseDistinctQueryMiddleware | MongooseDistinctQueryMiddleware[],

options: SchemaPostOptions,

fn: ErrorHandlingMiddlewareFunction<T>,

): this

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

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

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

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = THydratedDocumentType | Query<any, any>>(

method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp,

options: SchemaPostOptions & { document: true; query: true; },

fn: ErrorHandlingMiddlewareFunction<T>,

): this

post<T = THydratedDocumentType | Query<any, any>>(method: MongooseQueryOrDocumentMiddleware | MongooseQueryOrDocumentMiddleware[] | RegExp, fn: ErrorHandlingMiddlewareFunction<T>): this

post<T extends Aggregate<any>>(method: "aggregate" | RegExp, fn: PostMiddlewareFunction<T, Array<AggregateExtract<T>>>): this

post<T extends Aggregate<any>>(

method: "aggregate" | RegExp,

options: SchemaPostOptions,

fn: PostMiddlewareFunction<T, Array<AggregateExtract<T>>>,

): this

post<T = TModelType>(method: "insertMany" | RegExp, fn: PostMiddlewareFunction<T, T>): this

post<T = TModelType>(

method: "insertMany" | RegExp,

options: SchemaPostOptions,

fn: PostMiddlewareFunction<T, T>,

): this

post<T extends Aggregate<any>>(method: "aggregate" | RegExp, fn: ErrorHandlingMiddlewareFunction<T, Array<any>>): this

post<T extends Aggregate<any>>(

method: "aggregate" | RegExp,

options: SchemaPostOptions,

fn: ErrorHandlingMiddlewareFunction<T, Array<any>>,

): this

post<T = TModelType>(method:

| "bulkWrite"

| "createCollection"

| "insertMany"

| RegExp

, fn: ErrorHandlingMiddlewareFunction<T>): this

post<T = TModelType>(

method:

| "bulkWrite"

| "createCollection"

| "insertMany"

| RegExp

options: SchemaPostOptions,

fn: ErrorHandlingMiddlewareFunction<T>,

): this

Defines a post hook for the model.

Type Parameters

optional

T = Query<any, any>

Parameters

method: MongooseQueryMiddleware | MongooseQueryMiddleware[] | RegExp

options: SchemaPostOptions & { errorHandler: true; }

fn: ErrorHandlingMiddlewareWithOption<T>

fn: ErrorHandlingMiddlewareWithOption<T, Array<any>>

fn: ErrorHandlingMiddlewareWithOption<T>

fn: PostMiddlewareFunction<never, never>

fn: PostMiddlewareFunction<T, QueryResultType<T>>

fn: PostMiddlewareFunction<T, T>

fn: PostMiddlewareFunction<T, QueryResultType<T>>

fn: PostMiddlewareFunction<T, T | QueryResultType<T>>

fn: ErrorHandlingMiddlewareFunction<T>

fn: PostMiddlewareFunction<T, Array<AggregateExtract<T>>>

fn: PostMiddlewareFunction<T, T>

fn: ErrorHandlingMiddlewareFunction<T, Array<any>>

| "createCollection"

| "insertMany"

| RegExp

fn: ErrorHandlingMiddlewareFunction<T>

| "createCollection"

| "insertMany"

| RegExp

options: SchemaPostOptions

fn: ErrorHandlingMiddlewareFunction<T>

Returns

this