Client

Defined in: package/src/classes/Client.ts:27

Class representing a Discord client

Extends

• EventHandler<ClientEvents>

Constructors

Constructor

new Client(props): Client

Defined in: package/src/classes/Client.ts:83

Instantiate a new client

Parameters

props

ClientProps

Options such as token and intents

Returns

Client

Overrides

EventHandler.constructor

Properties

cache

cache: object

Defined in: package/src/classes/Client.ts:73

Internal cache for API structures

guilds

readonly guilds: CacheManager<Guild>

messages

readonly messages: CacheManager<Message>

users

readonly users: CacheManager<User>

---

destroyed

destroyed: boolean = false

Defined in: package/src/classes/Client.ts:34

Whether the client has been destroyed, used to prevent false reconnect attempts

---

heartbeatInterval?

optional heartbeatInterval: Timeout

Defined in: package/src/classes/Client.ts:40

Heartbeat interval provided by Discord’s gateway, cleared and recreated upon reconnecting

---

intents

intents: number

Defined in: package/src/classes/Client.ts:43

Parsed client intents bitfield

---

lastHeartbeatAck

lastHeartbeatAck: boolean = true

Defined in: package/src/classes/Client.ts:46

Whether the last heartbeat was acknowledged by Discord

---

presence

presence: ClientPresence = defaultClientPresence

Defined in: package/src/classes/Client.ts:49

The client’s current presence configuration

---

ready

ready: boolean = false

Defined in: package/src/classes/Client.ts:52

Whether the Dispatch (i.e., ready) event was received

---

rest

rest: RESTManager

Defined in: package/src/classes/Client.ts:55

REST manager used for API requests

---

sequenceNumber

sequenceNumber: number | null = null

Defined in: package/src/classes/Client.ts:61

Last sequence number provided by Discord’s gateway, used for heartbeats and session resuming

---

sessionId?

optional sessionId: string

Defined in: package/src/classes/Client.ts:64

Active session ID for resuming connection

---

user

user: ClientUser | null

Defined in: package/src/classes/Client.ts:67

Represents the client’s Discord user

---

ws?

optional ws: WebSocket

Defined in: package/src/classes/Client.ts:70

The WebSocket connected to Discord’s gateway

Accessors

token

Get Signature

get token(): string

Defined in: package/src/classes/Client.ts:131

Formatted bot token accessor, starting with “Bot ” and used for authentication

Returns

string

Methods

connect()

connect(): Promise<Client>

Defined in: package/src/classes/Client.ts:139

Fetches Discord’s gateway information then connects to it, and fetches the bot’s user before identifying

Returns

Promise<Client>

---

createMessage()

createMessage(channelId, props): Promise<void>

Defined in: package/src/classes/Client.ts:281

Sends a message to a specified channel

Parameters

channelId

string

ID of the channel to send the message to

props

CreateMessageProps

Message data, such as content

Returns

Promise<void>

---

disconnect()

disconnect(): void

Defined in: package/src/classes/Client.ts:392

Disconnects from Discord’s gateway and closes the WebSocket connection

Returns

void

---

emit()

emit<K>(event, …args): Promise<boolean>

Defined in: package/src/classes/EventHandler.ts:72

Calls all registered listeners for an event

Type Parameters

K

K extends keyof ClientEvents

Parameters

event

K

Event name

args

…ClientEvents[K]

Event arguments

Returns

Promise<boolean>

Inherited from

EventHandler.emit

---

fetchGuild()

fetchGuild(id, options?): Promise<Guild | null>

Defined in: package/src/classes/Client.ts:304

Fetches a guild by its ID

Parameters

id

string

ID of the guild to fetch

options?

Fetch options

force?

boolean

Returns

Promise<Guild | null>

Guild object or null

---

fetchUser()

fetchUser(id?, options?): Promise<User | null>

Defined in: package/src/classes/Client.ts:333

Fetches a user by their ID

Parameters

id?

string = "@me"

ID of the user to fetch (default: “@me”)

options?

Fetch options

force?

boolean

Returns

Promise<User | null>

User object or null

---

off()

off<K>(event, listener): Client

Defined in: package/src/classes/EventHandler.ts:52

Remove an event listener

Type Parameters

K

K extends keyof ClientEvents

Parameters

event

K

Event name

listener

(…args) => any

Listener callback

Returns

Client

Inherited from

EventHandler.off

---

on()

on<K>(event, listener): Client

Defined in: package/src/classes/EventHandler.ts:17

Add a new listener for a specified event

Type Parameters

K

K extends keyof ClientEvents

Parameters

event

K

Event name

listener

(…args) => any

Listener callback

Returns

Client

Inherited from

EventHandler.on

---

once()

once<K>(event, listener): Client

Defined in: package/src/classes/EventHandler.ts:34

Add a new listener for a specified event that only runs one time

Type Parameters

K

K extends keyof ClientEvents

Parameters

event

K

Event name

listener

(…args) => any

Listener callback

Returns

Client

Inherited from

EventHandler.once

---

setPresence()

setPresence(presence): Client

Defined in: package/src/classes/Client.ts:361

Updates the client’s presence and over the Gateway if connected

Parameters

presence

ClientPresenceProps

New presence information

Returns

Client

Client instance