Class UserManager<A>

Type Parameters

A = any

Index

Constructors

Methods

addRoleToUser createUser deleteUser getUser removeRoleFromUser updateAttributes updateUser

Constructors

constructor

new UserManager<A = any>(db: ValtheraCompatible): UserManager<A>
Type Parameters
- A = any
Parameters
- db: ValtheraCompatible
Returns UserManager<A>
- Defined in user.ts:5

Methods

addRoleToUser

addRoleToUser(user_id: string, role_id: string): Promise<void>
Adds a role to a user
Parameters
- user_id: string
  User _id
- role_id: string
  Role _id
Returns Promise<void>
- Defined in user.ts:54

createUser

createUser(
userData: { _id: string; attrib?: A; roles?: string[] },
): Promise<User<A>>
Creates a new user
Parameters
- userData: { _id: string; attrib?: A; roles?: string[] }
  User data (_id is required)
Returns Promise<User<A>>
- Defined in user.ts:11

deleteUser

deleteUser(user_id: string): Promise<void>
Deletes a user
Parameters
- user_id: string
  User _id
Returns Promise<void>
- Defined in user.ts:45

getUser

getUser(user_id: string): Promise<User<A>>
Retrieves a user by _id
Parameters
- user_id: string
  User _id
Returns Promise<User<A>>
User or null if it doesn't exist
- Defined in user.ts:25

removeRoleFromUser

removeRoleFromUser(user_id: string, role_id: string): Promise<void>
Removes a role from a user
Parameters
- user_id: string
  User _id
- role_id: string
  Role _id
Returns Promise<void>
- Defined in user.ts:68

updateAttributes

updateAttributes(user_id: string, attributes: Partial<A>): Promise<void>
Updates a user's attributes
Parameters
- user_id: string
  User _id
- attributes: Partial<A>
  New attributes to merge
Returns Promise<void>
- Defined in user.ts:83

updateUser

updateUser(user_id: string, updates: Partial<User<A>>): Promise<void>
Updates a user's data
Parameters
- user_id: string
  User _id
- updates: Partial<User<A>>
  Object with fields to update
Returns Promise<void>
- Defined in user.ts:34