Class BotSocketShard

Connects every bot shard to a {@link WebSocket} with the Discord Gateway. Handles gateway events and messages

Hierarchy

BotSocketShard

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BotSocketShard(botSocket: BotSocket, token: string, shard: ShardOptions): BotSocketShard

- Defined in src/socket/BotSocketShard.ts:130
Parameters
- botSocket: BotSocket
- token: string
- shard: ShardOptions
Returns BotSocketShard

Properties

pendingGuilds

pendingGuilds: Set<Snowflake>

All guilds pending to be cached from the gateway READY event

sequence

sequence: number | null

The sequence number of this shard

sessionId

sessionId: string

The session ID of this shard

Readonly shard

shard: ShardOptions

Holds shard details

state

state: BotSocketShardState

This shard's state

ws

ws: WebSocket

The WebSocket connection associated to this shard

Methods

close

close(code?: GatewayCloseCode): void

- Defined in src/socket/BotSocketShard.ts:356
Close the connection between the bot and the gateway

Parameters
- Default value code: GatewayCloseCode = GatewayCloseCode.NormalClosure
  
  Socket close code https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes
Returns void

configure

configure(): void

- Defined in src/socket/BotSocketShard.ts:155
Loads optional libraries and sets the options for the gateway websocket initialization

Returns void

connect

connect(resume?: boolean): Promise<void>

- Defined in src/socket/BotSocketShard.ts:189
Connects to the Discord Gateway and resumes a previous connection if needed

Parameters
- Default value resume: boolean = false
  
  Whether to resume a previous connection
Returns Promise<void>

pack

pack(data: unknown): Buffer | string | undefined

- Defined in src/socket/BotSocketShard.ts:486
Transfers the data into format which can be sent across the gateway

Parameters
- data: unknown
  
  Data to be transferred and sent to the gateway
Returns Buffer | string | undefined

ready

ready(): void

- Defined in src/socket/BotSocketShard.ts:374
Called when the bot is fully ready to proceed, after collecting all guilds from GUILD_CREATE events

Returns void

send

send(data: unknown): void

- Defined in src/socket/BotSocketShard.ts:462
Packs and sends the data to the WebSocket

Parameters
- data: unknown
  
  The data
Returns void

Generated using TypeDoc