Class Users

Index

Constructors

Accessors

Methods

add get load login password remove update

Constructors

constructor

new Users(options: UsersOptions): Users
Parameters
- options: UsersOptions
Returns Users
- Defined in core/kernel/src/tree/users.ts:14

Accessors

all

get all(): Map<number, User>
Returns Map<number, User>
- Defined in core/kernel/src/tree/users.ts:12

Methods

add

add(user: Partial<User>, options?: AddUserOptions): Promise<void>
Add a user to the system
Parameters
- user: Partial<User>
- options: AddUserOptions = {}
Returns Promise<void>
- Defined in core/kernel/src/tree/users.ts:21

get

get(uid: number): undefined | User
Get a user by UID
Parameters
- uid: number
Returns undefined | User
- Defined in core/kernel/src/tree/users.ts:96

load

load(): Promise<void>
Load users from the filesystem

Returns Promise<void>
- Defined in core/kernel/src/tree/users.ts:103

login

login(
username: string,
password: string,
): Promise<{ cred: Credentials; user: User }>
Login a user
Parameters
- username: string
- password: string
Returns Promise<{ cred: Credentials; user: User }>
- Defined in core/kernel/src/tree/users.ts:140

password

password(oldPassword: string, newPassword: string): Promise<void>
Parameters
- oldPassword: string
- newPassword: string
Returns Promise<void>
- Defined in core/kernel/src/tree/users.ts:154

remove

remove(uid: number): Promise<void>
Remove a user from the system
Parameters
- uid: number
Returns Promise<void>
- Defined in core/kernel/src/tree/users.ts:175

update

update(uid: number, user: Partial<User>): Promise<void>
Update a user
Parameters
- uid: number
- user: Partial<User>
Returns Promise<void>
- Defined in core/kernel/src/tree/users.ts:184