Skip to content

User class representing a user in the system

Properties

PropertyType
dbModelany
emailstring
idstring
passwordstring
permissionGroupstring
phonestring
typestring

Methods

getBrief()

getBrief(): UserDetail

Get brief user information

Returns

UserDetail

Brief user info object


hasPermission()

hasPermission(accessType): boolean

Check if user has a specific permission

Parameters

ParameterTypeDescription
accessTypestringPermission to check

Returns

boolean

True if user has permission, false otherwise


save()

save(): Promise<void>

Save user to database

Returns

Promise<void>


setNewDetail()

setNewDetail(detail): void

Update user details

Parameters

ParameterTypeDescription
detailUserDetailObject containing user details to update

Returns

void


createFromModel()

static createFromModel(model, detail): Promise<User>

Create user from model and details

Parameters

ParameterTypeDescription
modelModel<any>Mongoose model
detailUserDetailUser details

Returns

Promise<User>

Promise resolving to User instance


loadFromModel()

static loadFromModel(model): Promise<User>

Load user from database model

Parameters

ParameterTypeDescription
modelanyDatabase model

Returns

Promise<User>

Promise resolving to User instance


notValid()

static notValid(object): string

Create error for invalid user

Parameters

ParameterTypeDescription
objectanyInvalid user object

Returns

string

Error message