.connect()
→ Promise<void>
await client.ws.connect();Class
WebSocketManager
Extends EventEmitter
Constructor
new WebSocketManager(options: WebSocketManagerOptions)- options
WebSocketManagerOptions
Properties
| Name | Type | Description |
|---|---|---|
| pingread-only | number | Last gateway heartbeat ACK latency (RTT) in milliseconds (average across shards). -1 until the first ACK, or when no strategy is connected. Per-shard: manager.getShard(id)?.ping. |
Methods
.destroy()
→ void
client.ws.destroy();.fetchStatus()
→ Promise<Map<number, ShardStatus>>
Per-shard status map (empty before connect).
await client.ws.fetchStatus();.getGatewayUrl()
→ string
Context helpers for custom IShardingStrategy builders. Available after /gateway/bot resolves inside connect.
client.ws.getGatewayUrl();.getIdentifyThrottler()
client.ws.getIdentifyThrottler();.getOptions()
→ Readonly<WebSocketManagerOptions>
client.ws.getOptions();.getSessionStore()
client.ws.getSessionStore();.getShard(shardId)
shardId: number → WebSocketShard | undefined
client.ws.getShard(shardId);.getShardCount()
→ number
client.ws.getShardCount();.getShards()
→ ReadonlyMap<number, WebSocketShard>
Raw in-process shard handles when using SimpleShardingStrategy. Empty / undefined for worker strategies.
client.ws.getShards();.send(shardId, payload)
shardId: number, payload: GatewaySendPayload → void
client.ws.send(shardId, payload);