auth.UserServiceContract

Interface: UserServiceContract<UserType>

auth.UserServiceContract

Type parameters

Name	Type
UserType	extends ApplicationUserContract

Hierarchy

• UserServiceContract

  ↳ TestUserServiceContract

Implemented by

• UserService

Table of contents

Methods

• createFromExternalUserData
• getOneByExternalId
• getOneById
• getOneByUsernameAndPassword
• updateFromExternalUserData

Methods

createFromExternalUserData

▸ createFromExternalUserData(userData): UserID | Promise<UserID>

Parameters

Name	Type
userData	AuthProviderUserContract

Returns

UserID | Promise<UserID>

Defined in

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

---

getOneByExternalId

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

Parameters

Name	Type
externalId	UserID

Returns

null | UserType | Promise<null | UserType>

Defined in

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

---

getOneById

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

Parameters

Name	Type
userId	UserID

Returns

null | UserType | Promise<null | UserType>

Defined in

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

---

getOneByUsernameAndPassword

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

Parameters

Name	Type
username	string
password	string

Returns

null | UserType | Promise<null | UserType>

Defined in

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

---

updateFromExternalUserData

▸ updateFromExternalUserData(userData): UserID | Promise<UserID>

Parameters

Name	Type
userData	AuthProviderUserContract

Returns

UserID | Promise<UserID>

Defined in

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