Type aliases
AggregateHookFunction
Aggregate
HookFunction<T>: (this: Aggregate<T>, error?: Error, doc?: Aggregate<T>, next?: Fn) => R<unknown>Type parameters
Type declaration
-
- (this: Aggregate<T>, error?: Error, doc?: Aggregate<T>, next?: Fn): R<unknown>
-
Parameters
-
this: Aggregate<T>
-
Optional error: Error
-
Optional doc: Aggregate<T>
-
Optional next: Fn
Returns R<unknown>
AggregateMiddlewareType
AggregateMiddlewareType: "aggregate"
DocumentHookFunction
Type parameters
Type declaration
-
-
Parameters
-
-
Optional error: Error
-
-
Optional next: Fn
Returns R<unknown>
DocumentMiddlewareType
DocumentMiddlewareType: "validate" | "save" | "remove" | "init"
HookFunction
HookFunction<T>: T extends Document ? ModelHookFunction<T> | QueryHookFunction<T> : DocumentHookFunction<T> | AggregateHookFunction<T>
Type parameters
HookType
HookType: "pre" | "post"
ModelHookFunction
Model
HookFunction<T>: (this: Model<T>, error?: Error, doc?: Model<T>, next?: Fn) => R<unknown>Type parameters
Type declaration
-
- (this: Model<T>, error?: Error, doc?: Model<T>, next?: Fn): R<unknown>
-
Parameters
-
this: Model<T>
-
Optional error: Error
-
Optional doc: Model<T>
-
Optional next: Fn
Returns R<unknown>
ModelMiddlewareType
ModelMiddlewareType: "insertMany"
QueryHookFunction
Query
HookFunction<T>: (this: Query<T, T>, error?: Error, doc?: Query<T, T>, next?: Fn) => R<unknown>Type parameters
Type declaration
-
- (this: Query<T, T>, error?: Error, doc?: Query<T, T>, next?: Fn): R<unknown>
-
Parameters
-
this: Query<T, T>
-
Optional error: Error
-
Optional doc: Query<T, T>
-
Optional next: Fn
Returns R<unknown>
QueryMiddlewareType
QueryMiddlewareType: "count" | "find" | "findOne" | "findOneAndRemove" | "findOneAndUpdate" | "update" | "updateOne" | "updateMany"
R
R<T>: T | Promise<T>
Type parameters