UNPKG

@conpago/mongo-cursor-pagination

Version:

Make it easy to return cursor-paginated results from a Mongo collection

17 lines (16 loc) 806 B
import { Schema } from "mongoose"; import { QueryParams, SearchParams, Options, PaginationResponse, QueryParamsMulti } from "./types"; declare module "mongoose" { interface Model<TRawDocType, TQueryHelpers = {}, TInstanceMethods = {}, TVirtuals = {}, THydratedDocumentType = HydratedDocument<TRawDocType, TVirtuals & TInstanceMethods, TQueryHelpers>, TSchema = any> { paginate(params: QueryParams): Promise<PaginationResponse>; paginateMulti(params: QueryParamsMulti): Promise<PaginationResponse>; search(searchString: string, params: SearchParams): Promise<PaginationResponse>; } } /** * Mongoose plugin * @param {Schema} schema mongoose schema. * @param {Options} options */ declare const _default: (schema: Schema, options: Options) => void; export default _default;