hoshii / Exports / ClientUser

ClientUser

Represents a client user

Hierarchy

• Base<string>

  ↳ ClientUser

Table of contents

Constructors

• constructor

Properties

• botID
• client
• createdAt
• createdBy
• id
• name
• type

Accessors

• bot

Methods

• toJSON
• update

Constructors

constructor

• new ClientUser(data, client)

Create a new ClientUser

Parameters

Name	Type	Description
data	Object	The raw data of the client user
data.botId	string	-
data.createdAt	string	-
data.createdBy	string	-
data.id	string	-
data.name	string	-
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/ClientUser.ts:56

Properties

botID

• botID: string

The ID of the bot

Defined in

lib/structures/ClientUser.ts:29

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

createdAt

• createdAt: Date

The date the bot was created at

Defined in

lib/structures/ClientUser.ts:34

---

createdBy

• createdBy: string

The ID of the user who created the bot

Defined in

lib/structures/ClientUser.ts:39

---

id

• id: string

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

name

• name: string

The name of the bot

Defined in

lib/structures/ClientUser.ts:44

---

type

• type: string

The type of the user

Defined in

lib/structures/ClientUser.ts:49

Accessors

bot

• get bot(): boolean

Whether the user is a bot

Returns

boolean

Defined in

lib/structures/ClientUser.ts:71

Methods

toJSON

▸ toJSON(): ClientUserData

Returns the JSON representation of the item

Returns

ClientUserData

Overrides

Base.toJSON

Defined in

lib/structures/ClientUser.ts:75

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	Object
data.botId	string
data.createdAt	string
data.createdBy	string
data.id	string
data.name	string

Returns

void

Overrides

Base.update

Defined in

lib/structures/ClientUser.ts:86