Skip to content

Gateway

Defined in: packages/ws/src/index.ts:165

Manages a Discord Gateway connection.

new Gateway(options): Gateway

Defined in: packages/ws/src/index.ts:231

Creates a Gateway connection manager.

GatewayOptions

Gateway configuration.

Gateway

If configuration is invalid.

ping: number = -1

Defined in: packages/ws/src/index.ts:229


state: GatewayState = GatewayState.Connect

Defined in: packages/ws/src/index.ts:167

Current Gateway lifecycle state.

close(): void

Defined in: packages/ws/src/index.ts:421

Permanently closes the Gateway connection.

void


connect(url?): Promise<void>

Defined in: packages/ws/src/index.ts:368

Opens the Gateway connection.

string

Gateway WebSocket URL. Defaults to the URL of the last connect(), else Discord’s main Gateway. It is remembered: reconnects that IDENTIFY dial it again, and every reconnect (including a RESUME on resume_gateway_url) carries its query parameters (v, encoding, compress).

Promise<void>

Promise fulfilled when the socket opens; it rejects with a GatewayError if the Gateway was permanently closed or cannot connect.


emit(event, data?): void

Defined in: packages/ws/src/index.ts:434

Emits an event to all registered listeners.

string

Event name.

unknown

Event payload.

void


health(): GatewayHealth

Defined in: packages/ws/src/index.ts:453

A snapshot for dashboards and health checks: connection state, last heartbeat round trip, how long the link has been silent, and how many times it has reconnected.

GatewayHealth


off(event, listener): this

Defined in: packages/ws/src/index.ts:444

Removes a Gateway event listener.

string

Event name.

GatewayListener

Event callback.

this

This Gateway.


on(event, listener): this

Defined in: packages/ws/src/index.ts:437

string

GatewayListener

this


ownsGuild(guildId): boolean

Defined in: packages/ws/src/index.ts:534

Whether guildId maps to this Gateway’s shard ((id >> 22) % shardCount === shardId).

string

boolean


requestGuildMembers(data): boolean

Defined in: packages/ws/src/index.ts:544

Requests guild members.

Record<string, unknown>

Guild member request payload.

boolean

Whether it was sent.


send(payload): boolean

Defined in: packages/ws/src/index.ts:462

Sends a Gateway payload.

GatewayPayload

Gateway payload.

boolean

Whether it was sent.


sendVoiceState(guildId, channelId, options?): boolean

Defined in: packages/ws/src/index.ts:520

Joins, moves or leaves a voice channel (op 4). Returns false without sending when the guild belongs to another shard, or when disconnected.

string

Guild snowflake.

string | null

Channel to join, or null to leave.

selfMute and selfDeaf, both default false.

boolean

boolean

boolean

Whether it was sent.


setPresence(data): boolean

Defined in: packages/ws/src/index.ts:490

Sends a presence update.

GatewayPresence

Presence payload.

boolean

Whether it was sent.


setVoiceState(data): boolean

Defined in: packages/ws/src/index.ts:506

Sends a voice state update.

Record<string, unknown>

Voice state payload.

boolean

Whether it was sent.