Class UserInteractor

Interactor for User entity

Hierarchy

UserInteractor

Implements

EntityBase<User>
Updatable<User>

Index

Constructors

constructor

Properties

_entity

Methods

Constructors

constructor

new UserInteractor(user: User): UserInteractor

- Defined in modules/user/common/interactors/UserInteractor.ts:9
Parameters
- user: User
Returns UserInteractor

Properties

_entity

_entity: User

Methods

hashPassword

hashPassword(hashFn: HashFunction): User

- Defined in modules/user/common/interactors/UserInteractor.ts:44
Hashes user password

Parameters
- hashFn: HashFunction
  
  Hash function
Returns User

New User object with hashed password

matchPassword

matchPassword(password: string, hashFn: HashFunction): boolean

- Defined in modules/user/common/interactors/UserInteractor.ts:62
Matches stored password against provided

Parameters
- password: string
  
  Tested password
- hashFn: HashFunction
  
  Hash function
Returns boolean

Whether passwords match

stripUser

stripUser(): User

- Defined in modules/user/common/interactors/UserInteractor.ts:32
Strips User from any sensitive information such as password hash

Returns User

New stripped User object

update

update(fieldsToUpdate: Partial<Omit<User, "id">>): User

Implementation of Updatable.update
- Defined in modules/user/common/interactors/UserInteractor.ts:22
Update User

Parameters
- fieldsToUpdate: Partial<Omit<User, "id">>
  
  Field to be updated
Returns User

New updated User object

Generated using TypeDoc