API Reference
Rockets Core API
nestjs-user
classes
UserMutateService

Class: UserMutateService

User mutate service

Extends

Implements

Constructors

new UserMutateService()

new UserMutateService(repo, userPasswordService): UserMutateService

Constructor

Parameters

ParameterTypeDescription
repoRepository<UserEntityInterface>instance of the user repo
userPasswordServiceUserPasswordServiceinstance of a user password service

Returns

UserMutateService

Overrides

MutateService.constructor

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/services/user-mutate.service.ts:39 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueDescriptionOverrides
createDtoprotectedtypeof UserCreateDtoUserCreateDto-MutateService.createDto
updateDtoprotectedtypeof UserUpdateDtoUserUpdateDto-MutateService.updateDto
userPasswordServicereadonlyUserPasswordServiceundefinedinstance of a user password service-

Accessors

metadata

get protected metadata(): EntityMetadata

Internal

Returns

EntityMetadata

Inherited from

MutateService.metadata

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/base.service.d.ts:14

Methods

create()

create(data, queryOptions?): Promise<UserEntityInterface>

Create one

Parameters

ParameterTypeDescription
dataUserCreatableInterfacethe reference to create
queryOptions?QueryOptionsInterface-

Returns

Promise<UserEntityInterface>

the created reference

Implementation of

UserMutateServiceInterface.create

Inherited from

MutateService.create

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:9

find()

find(options, queryOptions?): Promise<Promise<UserEntityInterface[]>>

Find wrapper.

Parameters

ParameterTypeDescription
optionsFindManyOptions<UserEntityInterface>Find many options
queryOptions?QueryOptionsInterfaceQuery options

Returns

Promise<Promise<UserEntityInterface[]>>

Inherited from

MutateService.find

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/base.service.d.ts:10

findById()

protected findById(id, queryOptions?): Promise<UserEntityInterface>

Internal

Parameters

ParameterType
idstring
queryOptions?QueryOptionsInterface

Returns

Promise<UserEntityInterface>

Inherited from

MutateService.findById

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:17

findOne()

findOne(options, queryOptions?): Promise<null | UserEntityInterface>

Find One wrapper.

Parameters

ParameterTypeDescription
optionsFindOneOptions<UserEntityInterface>Find one options
queryOptions?QueryOptionsInterfaceQuery options

Returns

Promise<null | UserEntityInterface>

Inherited from

MutateService.findOne

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/base.service.d.ts:11

remove()

remove(data, queryOptions?): Promise<UserEntityInterface>

Remove one

Parameters

ParameterTypeDescription
dataDeepPartial<UserEntityInterface> & ReferenceIdInterface<string>the reference data to remove
queryOptions?QueryOptionsInterfacequery options

Returns

Promise<UserEntityInterface>

the removed reference

Implementation of

UserMutateServiceInterface.remove

Inherited from

MutateService.remove

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:12

replace()

replace(data, queryOptions?): Promise<UserEntityInterface>

Replace one

Parameters

ParameterTypeDescription
dataUserCreatableInterface & ReferenceIdInterface<string>the reference data to replace
queryOptions?QueryOptionsInterface-

Returns

Promise<UserEntityInterface>

the replaced reference

Implementation of

UserMutateServiceInterface.replace

Inherited from

MutateService.replace

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:11

repository()

repository(queryOptions?): Repository<UserEntityInterface>

Return the correct repository instance.

Parameters

ParameterTypeDescription
queryOptions?QueryOptionsInterfaceOptions

Returns

Repository<UserEntityInterface>

Inherited from

MutateService.repository

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/base.service.d.ts:12

transaction()

transaction(options?): TransactionProxy

Return a transaction instance.

Parameters

ParameterTypeDescription
options?SafeTransactionOptionsInterfaceOptions

Returns

TransactionProxy

Inherited from

MutateService.transaction

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/base.service.d.ts:13

transform()

protected transform<T>(user): Promise<DeepPartial<UserEntityInterface>>

Internal

Type Parameters

Type Parameter
T extends DeepPartial<UserEntityInterface>

Parameters

ParameterType
userT | T & PasswordPlainInterface

Returns

Promise<DeepPartial<UserEntityInterface>>

Overrides

MutateService.transform

Defined in

.tmp/repos/rockets/packages/nestjs-user/src/services/user-mutate.service.ts:47 (opens in a new tab)

update()

update(data, queryOptions?): Promise<UserEntityInterface>

Update one

Parameters

ParameterTypeDescription
dataUserUpdatableInterface & ReferenceIdInterface<string>the reference data to update
queryOptions?QueryOptionsInterface-

Returns

Promise<UserEntityInterface>

the updated reference

Implementation of

UserMutateServiceInterface.update

Inherited from

MutateService.update

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:10

validate()

protected validate<T>(type, data): Promise<T>

Internal

Type Parameters

Type Parameter
T extends DeepPartial<UserEntityInterface>

Parameters

ParameterType
typeType<T>
dataT

Returns

Promise<T>

Inherited from

MutateService.validate

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/mutate.service.d.ts:15

UserModuleUserPaginatedDto