Skip to content

auth.Interface.UserServiceContract

Sclable CI edited this page Apr 10, 2026 · 22 revisions

@sclable/nestjs-libs / auth / UserServiceContract

Interface: UserServiceContract<UserType>

Defined in: packages/auth/src/contracts/user-service.contract.ts:4

Extended by

Type Parameters

UserType

UserType extends ApplicationUserContract

Methods

createFromExternalUserData()

createFromExternalUserData(userData): UserID | Promise<UserID>

Defined in: packages/auth/src/contracts/user-service.contract.ts:11

Parameters

userData

AuthProviderUserContract

Returns

UserID | Promise<UserID>


getOneByExternalId()

getOneByExternalId(externalId): UserType | Promise<UserType | null> | null

Defined in: packages/auth/src/contracts/user-service.contract.ts:6

Parameters

externalId

UserID

Returns

UserType | Promise<UserType | null> | null


getOneById()

getOneById(userId): UserType | Promise<UserType | null> | null

Defined in: packages/auth/src/contracts/user-service.contract.ts:5

Parameters

userId

UserID

Returns

UserType | Promise<UserType | null> | null


getOneByUsernameAndPassword()

getOneByUsernameAndPassword(username, password): UserType | Promise<UserType | null> | null

Defined in: packages/auth/src/contracts/user-service.contract.ts:7

Parameters

username

string

password

string

Returns

UserType | Promise<UserType | null> | null


updateFromExternalUserData()

updateFromExternalUserData(userData): UserID | Promise<UserID>

Defined in: packages/auth/src/contracts/user-service.contract.ts:12

Parameters

userData

AuthProviderUserContract

Returns

UserID | Promise<UserID>

Clone this wiki locally