/// <reference types="mongoose/types/models" />
/// <reference types="mongoose/types/query" />
/// <reference types="mongoose/types/pipelinestage" />
import { Model, PipelineStage, Query } from "mongoose";
import { DocumentType } from "@typegoose/typegoose";
/**
 * The pagination options that can be passed.
 */
export interface IPaginateOptions {
    limit?: number;
    sortField?: string;
    sortAscending?: Boolean;
    next?: string;
    previous?: string;
}
/**
 * The result of the paginated find request
 */
export interface IPaginateResult<T> {
    hasNext?: boolean;
    hasPrevious?: boolean;
    next?: string;
    previous?: string;
    totalDocs: number;
    docs: T[];
}
/**
 * Verbosity mode for mongoDB's explain() function
 */
export type VerboseMode = "queryPlanner" | "executionStats" | "allPlansExecution";
/**
 * An extension of the mongoose Model which include the findPaged method.
 */
export interface IPaginateModel<T> extends Model<DocumentType<T>, {}> {
    findPaged(options: IPaginateOptions, query?: Object, projection?: Object, _populate?: (Object | string)[]): Query<IPaginateResult<DocumentType<T>>, DocumentType<T>>;
    findPagedExplain(options: IPaginateOptions, verbose?: VerboseMode, _query?: Object, _projection?: Object): Promise<any>;
    aggregatePaged(options: IPaginateOptions, pipeline: PipelineStage[]): Query<IPaginateResult<DocumentType<T>>, DocumentType<T>>;
}
/**
 * [Typegoose only] This is a type that you can cast your Typegoose model to
 * Example: export const UserModel = new User().getModelForClass(User) as PaginateModel<User, typeof User>;
 */
export type PaginateModel<T, T2> = IPaginateModel<DocumentType<T>> & T & T2;