kient / ChatUser
Class: ChatUser
src/structures/chat-user.ts:22
Data structure of a user account
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
_kient | readonly | Kient | - | BaseUser._kient | src/structures/base.ts:4 |
id | public | number | The user's id | BaseUser.id | src/structures/base-user.ts:14 |
identity? | public | object | The user's chat appearance | - | src/structures/chat-user.ts:36 |
identity.badges | public | object[] | The user's acquired chat badges | - | src/structures/chat-user.ts:45 |
identity.usernameColor | public | string | The user's color in chat | - | src/structures/chat-user.ts:40 |
isVerified | public | boolean | The user's verification status | - | src/structures/chat-user.ts:26 |
profilePicture | public | string | The user's profile picture url | BaseUser.profilePicture | src/structures/base-user.ts:24 |
slug | public | string | The user's channel slug | - | src/structures/chat-user.ts:31 |
username | public | string | The username of the user | BaseUser.username | src/structures/base-user.ts:19 |
Methods
toJSON()
ts
toJSON(): ExcludeFunctionsAndPrivate<ChatUser>src/structures/chat-user.ts:93
Returns
ExcludeFunctionsAndPrivate<ChatUser>
Overrides
constructChatUser()
ts
static constructChatUser(data): ExcludeFunctionsAndPrivate<ChatUser>src/structures/chat-user.ts:77
Parameters
| Parameter | Type |
|---|---|
data | ChatUserData |