class WebSocketManager

implements

AsyncDisposable
export declare class WebSocketManager extends AsyncEventEmitter<ManagerShardEventsMap> implements AsyncDisposable
options
token
[Symbol.asyncDispose]
connect
destroy
fetchStatus
getGatewayInformation
getShardCount
getShardIds
send
setToken
updateShardCount

Constructors

constructor(
options: CreateWebSocketManagerOptions
)

Constructs a new instance of the WebSocketManager class

readonly
options : Omit<WebSocketManagerOptions, 'token'>

The options being used by this manager

readonly
token : string

Gets the token set for this manager. If no token is set, an error is thrown. To set the token, use setToken or pass it in the options.

[Symbol.asyncDispose]() : Promise<void>

connect(
options: WebSocketManagerConnectOptions
) : Promise<void>

destroy(
options?: Omit<WebSocketShardDestroyOptions, 'recover'>
) : Promise<void>

Destroys all shards

fetchStatus() : Awaitable<Collection<number, WebSocketShardStatus>>

getGatewayInformation() : RESTGetAPIGatewayBotResult

The /gateway/bot information provided to connect. Throws if the method has not been invoked yet.

getShardCount() : number

Yields the total number of shards across for your bot, accounting for Discord recommendations

getShardIds() : number[]

Yields the ids of the shards this manager should manage

send(
shardId: number
payload: GatewaySendPayload
) : Awaitable<void>

setToken(
token: string
) : void

updateShardCount(
shardCount: number | null
) : Promise<this>

Updates your total shard count on-the-fly, re-spawning all shards to the new amount