Class ShardManager

Class used for managing shards for the user.

This class is automatically instantiated by the library and is documented for reference.

Hierarchy

  • ShardManager

Methods

_addListener _checkDisconnect _checkReady disconnect presenceUpdate requestGuildMembers shardPresenceUpdate spawn voiceStateUpdate

Properties

client concurrencyBucket identifyBucket options shards

Constructors

constructor

Methods

Private _addListener

  • _addListener(shard: Shard): void

  • Add event listeners to a shard to that the manager can act on received events.

    Parameters

    • shard: Shard

      Shard to add the event listeners to.

    Returns void

Private _checkDisconnect

  • _checkDisconnect(): void

  • Checks if all shards spawned by this manager are disconnected.

    Returns void

Private _checkReady

  • _checkReady(): void

  • Checks if all shards spawned by this manager are ready.

    Returns void

disconnect

  • Disconnect all shards facilitated by this manager.

    Returns void

presenceUpdate

  • Update the status of all currently connected shards which have been spawned by this manager.

    Parameters

    • data: GatewayPresenceUpdate

      Data to send.

    Returns Promise<void>

requestGuildMembers

  • Send an OP 8 REQUEST_GUILD_MEMBERS with a certain shard.

    Parameters

    • shardId: number

      id of the shard.

    • data: GuildRequestMembersPayload & {
          limit?: number;
      }

      Data to send.

    Returns Promise<void>

shardPresenceUpdate

  • Update the status of a single connected shard which has been spawned by this manager.

    Parameters

    • shardId: number

      id of the shard.

    • data: GatewayPresenceUpdate

      Data to send.

    Returns Promise<void>

spawn

  • Create shard instances and add them to the connection queue.

    Returns void

voiceStateUpdate

  • Send an OP 4 VOICE_STATE_UPDATE with a certain shard.

    Parameters

    • shardId: number

      id of the shard.

    • data: VoiceStateUpdatePayload & {
          self_deaf?: boolean;
          self_mute?: boolean;
      }

      Data to send.

    Returns Promise<void>

Properties

client

client: EventEmitter & {
    options: Omit<IClientOptions, "snowtransferInstance"> & {
        endpoint?: string;
        token: string;
    };
}

concurrencyBucket

concurrencyBucket: null | RatelimitBucket = null

identifyBucket

identifyBucket: RatelimitBucket

options

options: Omit<IClientOptions, "snowtransferInstance"> & {
    endpoint?: string;
    token: string;
}

shards

shards: {
    [id: number]: Shard;
}

Type declaration

Constructors

constructor

  • Create a new ShardManager.

    Parameters

    • client: EventEmitter & {
          options: Omit<IClientOptions, "snowtransferInstance"> & {
              endpoint?: string;
              token: string;
          };
      }

    Returns ShardManager

Settings

Member Visibility

Theme

Generated using TypeDoc