UNPKG

mongodb-dynamic-api

Version:

Auto generated CRUD API for MongoDB using NestJS

54 lines (53 loc) 2.57 kB
/// <reference types="mongoose/types/aggregate" /> /// <reference types="mongoose/types/callback" /> /// <reference types="mongoose/types/collection" /> /// <reference types="mongoose/types/connection" /> /// <reference types="mongoose/types/cursor" /> /// <reference types="mongoose/types/document" /> /// <reference types="mongoose/types/error" /> /// <reference types="mongoose/types/expressions" /> /// <reference types="mongoose/types/helpers" /> /// <reference types="mongoose/types/middlewares" /> /// <reference types="mongoose/types/indexes" /> /// <reference types="mongoose/types/models" /> /// <reference types="mongoose/types/mongooseoptions" /> /// <reference types="mongoose/types/pipelinestage" /> /// <reference types="mongoose/types/populate" /> /// <reference types="mongoose/types/query" /> /// <reference types="mongoose/types/schemaoptions" /> /// <reference types="mongoose/types/schematypes" /> /// <reference types="mongoose/types/session" /> /// <reference types="mongoose/types/types" /> /// <reference types="mongoose/types/utility" /> /// <reference types="mongoose/types/validation" /> /// <reference types="mongoose/types/virtuals" /> /// <reference types="mongoose/types/inferschematype" /> import { Type } from '@nestjs/common'; import { GetPagingResultResponse, GetResultResponse, PipelineStage } from 'mongodb-pipeline-builder'; import { FilterQuery, QueryOptions } from 'mongoose'; import { BaseEntity } from '../models'; type DynamicApiRepository<Entity extends BaseEntity> = { aggregate(pipeline: PipelineStage[]): Promise<GetResultResponse<Entity>>; bulkCreate(toCreateList: Partial<Entity>[]): Promise<Entity[]>; create(toCreate: Partial<Entity>): Promise<Entity>; delete(query: { id?: string; idList?: string[]; }): Promise<boolean>; find(query: FilterQuery<Entity>): Promise<Entity | null>; findAll(query?: FilterQuery<Entity>): Promise<Entity[]>; paginate(pipeline: PipelineStage[]): Promise<GetPagingResultResponse<Entity>>; update(query: FilterQuery<Entity>, toUpdate: Partial<Entity>, options?: QueryOptions<Entity>): Promise<Entity | null>; }; declare class RepositoryHelper { static getRepository<Entity extends BaseEntity>(entity: Type<Entity>): Promise<DynamicApiRepository<Entity>>; private static aggregate; private static paginate; private static findAll; private static find; private static create; private static update; private static delete; private static bulkCreate; } export { RepositoryHelper, DynamicApiRepository };