Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new ShardManager.

    Parameters

    Returns ShardManager

Properties

Private _addListener

_addListener: any

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

param shard

Shard to add the event listeners to.

Private _checkDisconnect

_checkDisconnect: any

Checks if all shards spawned by this manager are disconnected.

Private _checkReady

_checkReady: any

Checks if all shards spawned by this manager are ready.

client

client: <internal>.Client

concurrencyBucket

concurrencyBucket: null | RatelimitBucket

identifyBucket

identifyBucket: RatelimitBucket

options

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

shards

shards: {}

Type declaration

Static Readonly default

default: typeof ShardManager

Methods

disconnect

  • disconnect(): void

  • 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

    Returns Promise<void>

requestGuildMembers

  • Send an OP 8 REQUEST_GUILD_MEMBERS with a certain shard.

    Parameters

    Returns Promise<void>

shardPresenceUpdate

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

    Parameters

    Returns Promise<void>

spawn

  • spawn(): void

  • 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

    Returns Promise<void>

Generated using TypeDoc