API Reference
Rockets Core API
nestjs-user
classes
UserLookupService

Class: UserLookupService

User lookup service

Extends

Implements

Constructors

new UserLookupService()

new UserLookupService(repo): UserLookupService

Constructor

Parameters

ParameterTypeDescription
repoRepository<UserEntityInterface>instance of the user repo

Returns

UserLookupService

Overrides

LookupService.constructor

Defined in

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

Accessors

metadata

get protected metadata(): EntityMetadata

Internal

Returns

EntityMetadata

Inherited from

LookupService.metadata

Defined in

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

Methods

byEmail()

byEmail(email, queryOptions?): Promise<null | UserEntityInterface>

Get user for the given email.

Parameters

ParameterTypeDescription
emailstringthe email
queryOptions?QueryOptionsInterface-

Returns

Promise<null | UserEntityInterface>

Implementation of

UserLookupServiceInterface.byEmail

Defined in

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


byId()

byId(id, queryOptions?): Promise<null | UserEntityInterface>

Get entity for the given id.

Parameters

ParameterTypeDescription
idstringthe id
queryOptions?QueryOptionsInterfacequery options

Returns

Promise<null | UserEntityInterface>

Implementation of

UserLookupServiceInterface.byId

Inherited from

LookupService.byId

Defined in

.tmp/repos/rockets/packages/typeorm-common/dist/services/lookup.service.d.ts:7


bySubject()

bySubject(subject, queryOptions?): Promise<null | UserEntityInterface>

Get user for the given subject.

Parameters

ParameterTypeDescription
subjectstringthe subject
queryOptions?QueryOptionsInterface-

Returns

Promise<null | UserEntityInterface>

Implementation of

UserLookupServiceInterface.bySubject

Defined in

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


byUsername()

byUsername(username, queryOptions?): Promise<null | UserEntityInterface>

Get user for the given username.

Parameters

ParameterTypeDescription
usernamestringthe username
queryOptions?QueryOptionsInterface-

Returns

Promise<null | UserEntityInterface>

Implementation of

UserLookupServiceInterface.byUsername

Defined in

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


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

LookupService.find

Defined in

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


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

LookupService.findOne

Defined in

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


repository()

repository(queryOptions?): Repository<UserEntityInterface>

Return the correct repository instance.

Parameters

ParameterTypeDescription
queryOptions?QueryOptionsInterfaceOptions

Returns

Repository<UserEntityInterface>

Inherited from

LookupService.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

LookupService.transaction

Defined in

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