@aequum/mongoose/services/paginated/base-crudl-mongoose-paginated.service.d.ts

aequum mongoose tools for repository, pagination, CRUD/CRUDL, configs and utils

import * as mongoose from 'mongoose';
import 'mongoose-paginate-v2';
import { PaginateSortBy } from '@aequum/paginate-common';
import { MongoosePaginatedRepository } from '../../repositories/paginated';
import { BaseCRUDLMongooseService } from '..';
/**
 * Base CRUD/CRUDL Mongoose Service for a Mongoose Schema Model, with
 * paginated list output, by default assumes that the primary key
 * field as `id` provided by Virtual ID
 *
 * @typeParam SchemaModel Mongoose Schema Model
 * @typeParam SchemaModelDto DTO of the Mongoose Schema Model
 * @typeParam SchemaModelCreateDto DTO to create a new Mongoose Schema Model
 * @typeParam SchemaModelUpdateDto DTO to update a Mongoose Schema Model
 * @typeParam PaginatedSchemaModelDto Paginated DTO of the Mongoose Schema Model
 * @typeParam CustomFilterType Custom filter type to filter the query
 * @typeParam PrimaryKeyField Primary key field of the Mongoose Schema
 * Model by default is `id` (Virtual ID)
 */
export declare class BaseCRUDLMongoosePaginatedService<SchemaModel extends {
    [key in PrimaryKeyField]: any;
}, SchemaModelDto, SchemaModelCreateDto, SchemaModelUpdateDto, PaginatedSchemaModelDto, CustomFilterType = any, PrimaryKeyField extends string = 'id'> extends BaseCRUDLMongooseService<SchemaModel, SchemaModelDto, SchemaModelCreateDto, SchemaModelUpdateDto, CustomFilterType, PrimaryKeyField> {
    /** @inheritDoc */
    protected readonly repository: MongoosePaginatedRepository<SchemaModel>;
    /**
     * List all data entries paginated
     *
     * @param filter - Filter to apply to the query
     * @param page - Page number
     * @param size - Page size
     * @param sort - Sort options
     * @param projection - MongoDB projection
     * @param options - `mongoose-paginate-v2` options
     * @returns Paginated result
     *
     * @see [Options for `mongoose-paginate-v2`](https://github.com/aravindnc/mongoose-paginate-v2?tab=readme-ov-file#modelpaginatequery-options-callback)
     */
    paginatedList(filter: CustomFilterType, page: number, size: number, sort?: string | PaginateSortBy, projection?: mongoose.ProjectionType<SchemaModel>, options?: mongoose.PaginateOptions): Promise<PaginatedSchemaModelDto>;
}