class WebSocketManager

implements

AsyncDisposable
external
declare class WebSocketManager extends AsyncEventEmitter<ManagerShardEventsMap> implements AsyncDisposable

Constructors

external
constructor(
options: CreateWebSocketManagerOptions
)

Constructs a new instance of the WebSocketManager class

readonlyexternal
options : Omit<WebSocketManagerOptions, 'token'>

The options being used by this manager

readonlyexternal
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.

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

external
connect() : Promise<void>

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

external
fetchGatewayInformation(
force?: boolean
) : Promise<APIGatewayBotInfo>

Fetches the gateway information from Discord - or returns it from cache if available

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

external
getShardCount() : Promise<number>

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

external
getShardIds(
force?: boolean
) : Promise<number[]>

Yields the ids of the shards this manager should manage

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

external
setToken(
token: string
) : void

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

Updates your total shard count on-the-fly, spawning shards as needed