API Reference
Rockets Core API
nestjs-user
classes
UserController

Class: UserController

User controller.

Implements

Constructors

new UserController()

new UserController(userCrudService, userPasswordService): UserController

Constructor.

Parameters

ParameterTypeDescription
userCrudServiceUserCrudServiceinstance of the user crud service
userPasswordServiceUserPasswordServiceinstance of user password service

Returns

UserController

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:74 (opens in a new tab)

Methods

createMany()

createMany(crudRequest, userCreateManyDto): Promise<UserEntityInterface[]>

Create many

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object
userCreateManyDtoUserCreateManyDtouser create many dto

Returns

Promise<UserEntityInterface[]>

Implementation of

CrudControllerInterface.createMany

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:109 (opens in a new tab)


createOne()

createOne(crudRequest, userCreateDto): Promise<UserEntityInterface>

Create one

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object
userCreateDtoUserCreateDtouser create dto

Returns

Promise<UserEntityInterface>

Implementation of

CrudControllerInterface.createOne

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:134 (opens in a new tab)


deleteOne()

deleteOne(crudRequest): Promise<void | UserEntityInterface>

Delete one

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object

Returns

Promise<void | UserEntityInterface>

Implementation of

CrudControllerInterface.deleteOne

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:185 (opens in a new tab)


getMany()

getMany(crudRequest): Promise<UserEntityInterface[] | CrudResultPaginatedInterface<UserEntityInterface>>

Get many

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object

Returns

Promise<UserEntityInterface[] | CrudResultPaginatedInterface<UserEntityInterface>>

Implementation of

CrudControllerInterface.getMany

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:86 (opens in a new tab)


getOne()

getOne(crudRequest): Promise<UserEntityInterface>

Get one

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object

Returns

Promise<UserEntityInterface>

Implementation of

CrudControllerInterface.getOne

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:97 (opens in a new tab)


recoverOne()

recoverOne(crudRequest): Promise<UserEntityInterface>

Recover one

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object

Returns

Promise<UserEntityInterface>

Implementation of

CrudControllerInterface.recoverOne

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:196 (opens in a new tab)


updateOne()

updateOne(crudRequest, userUpdateDto, userId?, authorizededUser?): Promise<UserEntityInterface>

Update one

Parameters

ParameterTypeDescription
crudRequestCrudRequestInterfacethe CRUD request object
userUpdateDtoUserUpdateDtouser update dto
userId?string-
authorizededUser?AuthenticatedUserInterface-

Returns

Promise<UserEntityInterface>

Implementation of

CrudControllerInterface.updateOne

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/user.controller.ts:153 (opens in a new tab)