API Reference
Rockets Core API
nestjs-crud
interfaces
CrudControllerInterface

Interface: CrudControllerInterface<Entity, Creatable, Updatable, Replaceable>

Type Parameters

Type ParameterDefault type
Entity-
Creatable extends DeepPartial<Entity>-
Updatable extends DeepPartial<Entity>-
Replaceable extends CreatableCreatable

Properties

PropertyType
createMany?(crudRequest: CrudRequestInterface, dto: CreateManyDto<Creatable>, ...rest: AdditionalCrudMethodArgs) => Promise<Entity[]>
createOne?(crudRequest: CrudRequestInterface, dto: Creatable, ...rest: AdditionalCrudMethodArgs) => Promise<Entity>
deleteOne?(crudRequest: CrudRequestInterface, ...rest: AdditionalCrudMethodArgs) => Promise<void | Entity>
getMany?(crudRequest: CrudRequestInterface, ...rest: AdditionalCrudMethodArgs) => Promise<CrudResponsePaginatedInterface<Entity> | Entity[]>
getOne?(crudRequest: CrudRequestInterface, ...rest: AdditionalCrudMethodArgs) => Promise<Entity>
recoverOne?(crudRequest: CrudRequestInterface, ...rest: AdditionalCrudMethodArgs) => Promise<Entity>
replaceOne?(crudRequest: CrudRequestInterface, dto: Replaceable, ...rest: AdditionalCrudMethodArgs) => Promise<Entity>
updateOne?(crudRequest: CrudRequestInterface, dto: Updatable, ...rest: AdditionalCrudMethodArgs) => Promise<Entity>