kient / UserAPI

Class: UserAPI

src/api/user/index.ts:9

Description placeholder

Extends

• APIBase

Constructors

new UserAPI()

new UserAPI(kient): UserAPI

src/api/api-base.ts:7

Parameters

Parameter	Type
kient	Kient

Returns

UserAPI

Inherited from

APIBase.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
kient	readonly	Kient	APIBase.kient	src/api/api-base.ts:5

Methods

getAuthorisedUser()

getAuthorisedUser(): Promise<User>

src/api/user/index.ts:31

Returns the currently authorised user's details

Returns

Promise<User>

---

getById()

getById(id): Promise<User>

src/api/user/index.ts:24

Returns a singular user by ID

Parameters

Parameter	Type	Description
id	number	Accepts a singular user ID that will be queried for

Returns

Promise<User>

---

getByIds()

getByIds(ids): Promise<User[]>

src/api/user/index.ts:15

Returns an array of users by an array of IDs

Parameters

Parameter	Type	Description
ids	number[]	Accepts an array of user IDs that will be queried for

Returns

Promise<User[]>