ts-mongoose-pagination/dist/index.d.ts

Typescript pagination plugin for mongoose

/// <reference types="mongoose" />
declare module "mongoose" {
    interface IPaginateOptions {
        select?: Object | string;
        sort?: Object | string;
        collation?: CollationOptions;
        projection?: Object | string;
        populate?: Object[] | string[] | Object | string;
        lean?: boolean;
        page?: number;
        perPage?: number;
    }
    interface IPaginateDefaultOptions {
        select: string;
        projection: string;
        lean: boolean;
        perPage: number;
    }
    interface IPaginateResult<T> {
        data: T[];
        pagination: IPagination;
    }
    interface IPagination {
        hasPrevPage: boolean;
        hasNextPage: boolean;
        prevPage: number | null;
        nextPage: number | null;
        perPage: number;
        page?: number | null;
        totalPages?: number;
    }
    interface PaginateModel<T extends Document> extends Model<T> {
        paginate(query?: object, options?: IPaginateOptions, callback?: (err: any, result: IPaginateResult<T>) => void): Promise<IPaginateResult<T>>;
    }
    function model(name: string, schema?: Schema, collection?: string, skipInit?: boolean): PaginateModel<any>;
}
export * from "./mongoose-pagination/pagination";