@elsikora/nestjs-crud-automator
Version:
A library for automating the creation of CRUD operations in NestJS.
17 lines (16 loc) • 1.5 kB
TypeScript
import type { IApiGetListResponseResult } from '../../interface/decorator/api/index';
import type { TApiFunctionCreateProperties, TApiFunctionDeleteCriteria, TApiFunctionGetListProperties, TApiFunctionGetManyProperties, TApiFunctionGetProperties, TApiFunctionUpdateCriteria, TApiFunctionUpdateProperties } from '../../type/decorator/api/function/index';
import type { EntityManager } from "typeorm";
/**
* Base class for services providing CRUD operations.
* @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/classes#apiservicebase | API Reference - ApiServiceBase}
* @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/services | Core Concepts - Services}
*/
export declare class ApiServiceBase<E> {
create(properties: TApiFunctionCreateProperties<E>, eventManager?: EntityManager): Promise<E>;
delete(criteria: Array<TApiFunctionDeleteCriteria<E>> | TApiFunctionDeleteCriteria<E>, eventManager?: EntityManager): Promise<void>;
get(properties: TApiFunctionGetProperties<E>, eventManager?: EntityManager): Promise<E>;
getList(properties: TApiFunctionGetListProperties<E>, eventManager?: EntityManager): Promise<IApiGetListResponseResult<E>>;
getMany(properties: TApiFunctionGetManyProperties<E>, eventManager?: EntityManager): Promise<Array<E>>;
update(criteria: Array<TApiFunctionUpdateCriteria<E>> | TApiFunctionUpdateCriteria<E>, properties: TApiFunctionUpdateProperties<E>, eventManager?: EntityManager): Promise<E>;
}