User class representing a user in the system
Properties
Property | Type |
---|---|
dbModel | any |
email | string |
id | string |
password | string |
permissionGroup | string |
phone | string |
type | string |
Methods
getBrief()
getBrief():
UserDetail
Get brief user information
Returns
Brief user info object
hasPermission()
hasPermission(
accessType
):boolean
Check if user has a specific permission
Parameters
Parameter | Type | Description |
---|---|---|
accessType | string | Permission 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
Parameter | Type | Description |
---|---|---|
detail | UserDetail | Object containing user details to update |
Returns
void
createFromModel()
static
createFromModel(model
,detail
):Promise
<User
>
Create user from model and details
Parameters
Parameter | Type | Description |
---|---|---|
model | Model <any > | Mongoose model |
detail | UserDetail | User details |
Returns
Promise
<User
>
Promise resolving to User instance
loadFromModel()
static
loadFromModel(model
):Promise
<User
>
Load user from database model
Parameters
Parameter | Type | Description |
---|---|---|
model | any | Database model |
Returns
Promise
<User
>
Promise resolving to User instance
notValid()
static
notValid(object
):string
Create error for invalid user
Parameters
Parameter | Type | Description |
---|---|---|
object | any | Invalid user object |
Returns
string
Error message