Class WebSocketManager

Hierarchy (View Summary)

AsyncEventEmitter<ManagerShardEventsMap>
- WebSocketManager

Implements

AsyncDisposable

Constructors

constructor

new WebSocketManager(options: CreateWebSocketManagerOptions): WebSocketManager
Parameters
- options: CreateWebSocketManagerOptions
Returns WebSocketManager
Overrides AsyncEventEmitter.constructor
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:448

Properties

`Protected` `Readonly`[brandSymbol]

"[brandSymbol]": ManagerShardEventsMap

This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

`Readonly`options

options: WebSocketManagerOptions

The options being used by this manager

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:473

addListener

addListener<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:469

destroy

destroy(
options?: Omit<WebSocketShardDestroyOptions, "recover">,
): Awaitable<void>
Parameters
- Optionaloptions: Omit<WebSocketShardDestroyOptions, "recover">
Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:470

emit

emit<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
    >,
): boolean
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<
  AsyncEventEmitter<ManagerShardEventsMap>,
  K,
  >
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit<K extends string | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
    >,
): boolean
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<
  AsyncEventEmitter<ManagerShardEventsMap>,
  K,
  >
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38

eventNames

eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ManagerShardEventsMap
)[]
Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ManagerShardEventsMap
)[]
Inherited from AsyncEventEmitter.eventNames
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45

fetchGatewayInformation

fetchGatewayInformation(force?: boolean): Promise<APIGatewayBotInfo>
Fetches the gateway information from Discord - or returns it from cache if available
Parameters
- Optionalforce: boolean
  Whether to ignore the cache and force a fresh fetch
Returns Promise<APIGatewayBotInfo>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:454

fetchStatus

fetchStatus(): Awaitable<Collection<number, WebSocketShardStatus>>
Returns Awaitable<Collection<number, WebSocketShardStatus>>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:472

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from AsyncEventEmitter.getMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32

getShardCount

getShardCount(): Promise<number>
Yields the total number of shards across for your bot, accounting for Discord recommendations

Returns Promise<number>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:464

getShardIds

getShardIds(force?: boolean): Promise<number[]>
Yields the ids of the shards this manager should manage
Parameters
- Optionalforce: boolean
Returns Promise<number[]>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:468

listenerCount

listenerCount<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
): number
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName: string | symbol): number
Parameters
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40

listeners

listeners<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
        ManagerShardEventsMap,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
        ManagerShardEventsMap,
    >["listener"],
    undefined,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners<K extends string | symbol>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
        ManagerShardEventsMap,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<ManagerShardEventsMap>,
        K,
        ManagerShardEventsMap,
    >["listener"],
    undefined,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34

off

off<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26

on

on<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

once

once<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

prependListener

prependListener<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42

prependOnceListener

prependOnceListener<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44

rawListeners

rawListeners<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ManagerShardEventsMap>,
    K,
    ManagerShardEventsMap,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ManagerShardEventsMap>,
    K,
    ManagerShardEventsMap,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners<K extends string | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ManagerShardEventsMap>,
    K,
    ManagerShardEventsMap,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<ManagerShardEventsMap>,
    K,
    ManagerShardEventsMap,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36

removeAllListeners

removeAllListeners<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    event: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- event: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    event?: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- Optionalevent: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event: string | symbol): this
Parameters
- event: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event?: string | symbol): this
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:30

removeListener

removeListener<
    K extends
        | (keyof AsyncEventEmitterPredefinedEvents)
        | (keyof ManagerShardEventsMap),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof ManagerShardEventsMap)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<ManagerShardEventsMap>,
            K,
            ManagerShardEventsMap,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<ManagerShardEventsMap>,
          K,
          ManagerShardEventsMap,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24

send

send(shardId: number, payload: GatewaySendPayload): Awaitable<void>
Parameters
- shardId: number
- payload: GatewaySendPayload
Returns Awaitable<void>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:471

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from AsyncEventEmitter.setMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31

updateShardCount

updateShardCount(shardCount: null | number): Promise<WebSocketManager>
Updates your total shard count on-the-fly, spawning shards as needed
Parameters
- shardCount: null | number
  The new shard count to use
Returns Promise<WebSocketManager>
- Defined in node_modules/@discordjs/ws/dist/index.d.ts:460

waitForAllListenersToComplete

waitForAllListenersToComplete(): Promise<boolean>
Returns Promise<boolean>
Inherited from AsyncEventEmitter.waitForAllListenersToComplete
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:46

`Static`listenerCount

listenerCount<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
): number
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(
emitter: AsyncEventEmitter<any>,
eventName: string | symbol,
): number
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:50

`Static`on

on<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
on(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): AsyncGenerator<any[], void>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<any[], void>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54

`Static`once

once<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): Promise<any[]>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns Promise<any[]>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52

Class WebSocketManager

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketManager

Properties

Protected Readonly[brandSymbol]

Readonlyoptions

Methods

[asyncDispose]

Returns Promise<void>

addListener

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

connect

Returns Promise<void>

destroy

Parameters

Returns Awaitable<void>

emit

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & ( keyof ManagerShardEventsMap)[]

fetchGatewayInformation

Parameters

Returns Promise<APIGatewayBotInfo>

fetchStatus

Returns Awaitable<Collection<number, WebSocketShardStatus>>

getMaxListeners

Returns number

getShardCount

Returns Promise<number>

getShardIds

Parameters

Returns Promise<number[]>

listenerCount

Type Parameters

Parameters

Returns number

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Exclude< InternalAsyncEventEmitterInternalListenerForEvent< AsyncEventEmitter<ManagerShardEventsMap>, K, ManagerShardEventsMap, >["listener"], undefined,>[]

Type Parameters

Parameters

Returns Exclude< InternalAsyncEventEmitterInternalListenerForEvent< AsyncEventEmitter<ManagerShardEventsMap>, K, ManagerShardEventsMap, >["listener"], undefined,>[]

off

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

`Protected` `Readonly`[brandSymbol]

`Readonly`options

Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof ManagerShardEventsMap
)[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ManagerShardEventsMap>,
K,
ManagerShardEventsMap,
>["listener"],
undefined,
>[]

Returns Exclude<
InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ManagerShardEventsMap>,
K,
ManagerShardEventsMap,
>["listener"],
undefined,
>[]

Returns InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ManagerShardEventsMap>,
K,
ManagerShardEventsMap,
>[]

Returns InternalAsyncEventEmitterInternalListenerForEvent<
AsyncEventEmitter<ManagerShardEventsMap>,
K,
ManagerShardEventsMap,
>[]

`Static`listenerCount

`Static`on

Returns AsyncGenerator<
InternalGetAsyncEventEmitterEventParameters<
AsyncEventEmitter<EventMap>,
EventName,
EventMap,
>,
void,
>

`Static`once

Returns Promise<
InternalGetAsyncEventEmitterEventParameters<
AsyncEventEmitter<EventMap>,
EventName,
EventMap,
>,
>