@dmxdev/mongoose-paginated-query/dist/index.d.ts

Mongodb Paginate Queries Package

import { Model } from 'mongoose';
/**
 * Options for populating documents in Mongoose.
 *
 * @typedef {Object} PopulateOptions
 * @property {string} path - The path of the field to populate.
 * @property {string | Record<string, number>} [select] - Fields to include or exclude in the populated documents.
 * @property {Record<string, unknown>} [match] - Conditions to match documents for population.
 * @property {Object} [options] - Additional options for population.
 * @property {Record<string, 1 | -1>} [options.sort] - Sort order for the populated documents.
 * @property {number} [options.limit] - Limit the number of populated documents.
 * @property {number} [options.skip] - Skip the specified number of populated documents.
 * @property {string} [localField] - The local field to match with the foreign field.
 * @property {string} [foreignField] - The foreign field to match with the local field.
 * @property {PopulateOptions | PopulateOptions[]} [populate] - Nested population options.
 */
export type PopulateOptions = {
    path: string;
    select?: string | Record<string, number>;
    match?: Record<string, unknown>;
    options?: {
        sort?: Record<string, 1 | -1>;
        limit?: number;
        skip?: number;
    };
    localField?: string;
    foreignField?: string;
    populate?: PopulateOptions | PopulateOptions[];
};
export type PopulateArray = PopulateOptions[];
/**
 * Represents the input type for population in Mongoose pagination.
 *
 * This can be one of the following types:
 * - `string`: A string representing the path to populate.
 * - `PopulateOptions`: An object containing options for population.
 * - `PopulateArray`: An array of paths or options for population.
 */
export type PopulateInput = PopulateOptions | PopulateOptions[];
/**
 * Interface representing the options for pagination.
 *
 * @property {number} page - The current page number.
 * @property {number} limit - The number of items per page.
 * @property {Record<string, any>} [sort] - Optional sorting criteria.
 * @property {PopulateInput} [populate] - Optional population criteria.
 */
export interface PaginationResult<T> {
    docs: T[];
    totalDocs: number;
    limit: number;
    page: number;
    totalPages: number;
    hasNextPage: boolean;
    hasPrevPage: boolean;
}
/**
 * Options for pagination.
 *
 * @property {number} page - The page number to retrieve.
 * @property {number} limit - The number of items per page.
 * @property {Record<string, any>} [sort] - Optional sorting criteria.
 * @property {PopulateOptions[]} [populate] - Optional population options for related documents.
 */
export interface PaginationOptions {
    page: number;
    limit: number;
    sort?: Record<string, any>;
}
export interface PaginateParams {
    options: PaginationOptions;
    query?: Record<string, any>;
    populate?: PopulateInput;
    select?: string;
}
export interface MongoosePaginateParams<T> {
    schema: Model<T>;
    options: PaginationOptions;
    query?: Record<string, any>;
    populate?: PopulateInput;
    select?: string;
}
/**
 * Paginates a Mongoose model query.
 *
 * @template T - The type of the documents being queried.
 * @param {Model<T>} schema - The Mongoose model to query.
 * @param {PaginationOptions} options - The pagination options.
 * @param {Record<string, any>} [query] - The query conditions.
 * @returns {Promise<{
 *   docs: T[];
 *   totalDocs: number;
 *   limit: number;
 *   page: number;
 *   totalPages: number;
 *   hasNextPage: boolean;
 *   hasPrevPage: boolean;
 * }>} - An object containing the paginated results and pagination information.
 */
declare const mongoosePaginate: <T>({ schema, options, query, populate, select, }: MongoosePaginateParams<T>) => Promise<PaginationResult<T>>;
export default mongoosePaginate;