mongoose/types/middlewares.d.ts

Mongoose MongoDB ODM

declare module 'mongoose' {
  import Kareem = require('kareem');

  type MongooseQueryAndDocumentMiddleware = 'updateOne' | 'deleteOne';

  type MongooseDistinctDocumentMiddleware = 'save' | 'validate';
  type MongooseDocumentMiddleware = MongooseDistinctDocumentMiddleware | MongooseQueryAndDocumentMiddleware;

  type MongooseRawResultQueryMiddleware = 'findOneAndUpdate' | 'findOneAndReplace' | 'findOneAndDelete';
  type MongooseDistinctQueryMiddleware = 'estimatedDocumentCount' | 'countDocuments' | 'deleteMany' | 'distinct' | 'find' | 'findOne' | 'findOneAndDelete' | 'findOneAndReplace' | 'findOneAndUpdate' | 'replaceOne' | 'updateMany';

  type MongooseDefaultQueryMiddleware = MongooseDistinctQueryMiddleware | 'updateOne' | 'deleteOne';
  type MongooseQueryMiddleware = MongooseDistinctQueryMiddleware | MongooseQueryAndDocumentMiddleware;

  type MongooseQueryOrDocumentMiddleware = MongooseDistinctQueryMiddleware|MongooseDistinctDocumentMiddleware|MongooseQueryAndDocumentMiddleware;

  type MiddlewareOptions = {
    /**
      * Enable this Hook for the Document Methods
      * @default true
      */
    document?: boolean,
    /**
      * Enable this Hook for the Query Methods
      * @default true
      */
    query?: boolean,
    /**
      * Explicitly set this function to be a Error handler instead of based on how many arguments are used
      * @default false
      */
    errorHandler?: boolean
  };
  type SchemaPreOptions = MiddlewareOptions;
  type SchemaPostOptions = MiddlewareOptions;

  interface SkipMiddlewareOptions {
    /** If `false`, skip pre middleware. */
    pre?: boolean;
    /** If `false`, skip post middleware. */
    post?: boolean;
  }

  interface SupportsMiddlewareOption {
    /**
     * Set to `true` to let callers skip this custom static's or method's middleware
     * by passing `{ middleware: false }` as the last argument.
     * See [skipping middleware for custom statics and methods](https://mongoosejs.com/docs/middleware.html#skip-custom-statics-and-methods).
     */
    supportsMiddlewareOption?: boolean;
  }

  type PreMiddlewareFunction<ThisType = any> = (
    this: ThisType,
    opts?: Record<string, any>
  ) => void | Promise<void> | Kareem.SkipWrappedFunction;
  type PreDeleteOneMiddlewareFunction<ThisType = any> = (
    this: ThisType,
    doc: ThisType,
    opts?: Record<string, any>
  ) => void | Promise<void> | Kareem.SkipWrappedFunction;
  type PreUpdateOneMiddlewareFunction<ThisType = any> = (
    this: ThisType,
    doc: ThisType,
    update?: Record<string, any>,
    opts?: Record<string, any>
  ) => void | Promise<void> | Kareem.SkipWrappedFunction;
  type PreSaveMiddlewareFunction<ThisType = any> = (
    this: ThisType,
    opts: SaveOptions
  ) => void | Promise<void> | Kareem.SkipWrappedFunction;
  type PostMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, res: ResType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void> | Kareem.OverwriteResult;
  type ErrorHandlingMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType, next: CallbackWithoutResultAndOptionalError) => void;
  type ErrorHandlingMiddlewareWithOption<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType | null, next: CallbackWithoutResultAndOptionalError) => void | Promise<void> | Kareem.OverwriteResult;
}