Class ShardManager

A manager for all the client's shards.

Hierarchy (view full)

Collection<number, Shard>
- ShardManager

Index

Constructors

constructor

new ShardManager(client, options?): ShardManager
Parameters
- client: Client<ClientEvents>
- options: GatewayOptions = {}
Returns ShardManager
Overrides Collection.constructor
- Defined in lib/gateway/ShardManager.ts:32

Properties

`Readonly` [toStringTag]

[toStringTag]: string

connected

connected: boolean = false

options

options: ShardManagerInstanceOptions

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

empty

get empty(): boolean
If this collection is empty.

Returns boolean
Inherited from Collection.empty
- Defined in lib/util/Collection.ts:5

Methods

[iterator]

[iterator](): IterableIterator<[number, Shard]>
Returns an iterable of entries in the map.

Returns IterableIterator<[number, Shard]>
Inherited from Collection.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from Collection.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in lib/gateway/ShardManager.ts:152

delete

delete(key): boolean
Parameters
- key: number
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Collection.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

disconnect

disconnect(reconnect?): void
Disconnect all shards.
Parameters
- reconnect: boolean = ...
  If shards should be reconnected. Defaults to GatewayOptions#autoReconnect
Returns void
- Defined in lib/gateway/ShardManager.ts:239

entries

entries(): IterableIterator<[number, Shard]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[number, Shard]>
Inherited from Collection.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

every

every<T, ThisArg>(predicate, thisArg?): this is T[]
See: Array#every
Type Parameters
- T extends Shard
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value, index, array) => value is T)
  - - (value, index, array): value is T
    - Parameters
      value: Shard
      index: number
      array: Shard[]
      Returns value is T
- Optional thisArg: ThisArg
Returns this is T[]
Inherited from Collection.every
- Defined in lib/util/Collection.ts:10
every<ThisArg>(predicate, thisArg?): boolean
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: Shard
      index: number
      array: Shard[]
      Returns unknown
- Optional thisArg: ThisArg
Returns boolean
Inherited from Collection.every
- Defined in lib/util/Collection.ts:11

filter

filter<S, ThisArg>(predicate, thisArg?): S[]
See: Array#filter
Type Parameters
- S extends Shard
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this, value, index, array) => value is S)
  - - (this, value, index, array): value is S
    - Parameters
      this: ThisArg
      value: Shard
      index: number
      array: Shard[]
      Returns value is S
- Optional thisArg: ThisArg
Returns S[]
Inherited from Collection.filter
- Defined in lib/util/Collection.ts:18
filter<ThisArg>(predicate, thisArg?): Shard[]
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this, value, index, array) => unknown)
  - - (this, value, index, array): unknown
    - Parameters
      this: ThisArg
      value: Shard
      index: number
      array: Shard[]
      Returns unknown
- Optional thisArg: ThisArg
Returns Shard[]
Inherited from Collection.filter
- Defined in lib/util/Collection.ts:19

find

find<S, ThisArg>(predicate, thisArg?): undefined | S
See: Array#find
Type Parameters
- S extends Shard
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this, value, index, obj) => value is S)
  - - (this, value, index, obj): value is S
    - Parameters
      this: ThisArg
      value: Shard
      index: number
      obj: Shard[]
      Returns value is S
- Optional thisArg: ThisArg
Returns undefined | S
Inherited from Collection.find
- Defined in lib/util/Collection.ts:25
find<ThisArg>(predicate, thisArg?): undefined | Shard
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this, value, index, obj) => unknown)
  - - (this, value, index, obj): unknown
    - Parameters
      this: ThisArg
      value: Shard
      index: number
      obj: Shard[]
      Returns unknown
- Optional thisArg: ThisArg
Returns undefined | Shard
Inherited from Collection.find
- Defined in lib/util/Collection.ts:26

findIndex

findIndex(predicate, thisArg?): number
See: Array#findIndex
Parameters
- predicate: ((value, index, obj) => unknown)
  - - (value, index, obj): unknown
    - Parameters
      value: Shard
      index: number
      obj: Shard[]
      Returns unknown
- Optional thisArg: unknown
Returns number
Inherited from Collection.findIndex
- Defined in lib/util/Collection.ts:32

first

first(): undefined | Shard
Get the first element, or first X elements if a number is provided.

Returns undefined | Shard
Inherited from Collection.first
- Defined in lib/util/Collection.ts:40
first(amount): Shard[]
Parameters
- amount: number
Returns Shard[]
Inherited from Collection.first
- Defined in lib/util/Collection.ts:41

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: Shard
      key: number
      map: Map<number, Shard>
      Returns void
- Optional thisArg: any
Returns void
Inherited from Collection.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key): undefined | Shard
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: number
Returns undefined | Shard
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Collection.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key): boolean
Parameters
- key: number
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Collection.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): IterableIterator<number>
Returns an iterable of keys in the map

Returns IterableIterator<number>
Inherited from Collection.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

last

last(): undefined | Shard
Get the last element, or last X elements if a number is provided.

Returns undefined | Shard
Inherited from Collection.last
- Defined in lib/util/Collection.ts:61
last(amount): Shard[]
Parameters
- amount: number
Returns Shard[]
Inherited from Collection.last
- Defined in lib/util/Collection.ts:62

map

map<T>(predicate, thisArg?): T[]
See: Array#map
Type Parameters
- T
Parameters
- predicate: ((value, index, obj) => T)
  - - (value, index, obj): T
    - Parameters
      value: Shard
      index: number
      obj: Shard[]
      Returns T
- Optional thisArg: unknown
Returns T[]
Inherited from Collection.map
- Defined in lib/util/Collection.ts:79

random

random(): undefined | Shard
Pick a random element from the collection, or undefined if the collection is empty.

Returns undefined | Shard
Inherited from Collection.random
- Defined in lib/util/Collection.ts:86

reduce

reduce(predicate): Shard
See: Array#reduce
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => Shard)
  - - (previousValue, currentValue, currentIndex, array): Shard
    - Parameters
      previousValue: Shard
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns Shard
Returns Shard
Inherited from Collection.reduce
- Defined in lib/util/Collection.ts:96
reduce(predicate, initialValue): Shard
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => Shard)
  - - (previousValue, currentValue, currentIndex, array): Shard
    - Parameters
      previousValue: Shard
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns Shard
- initialValue: Shard
Returns Shard
Inherited from Collection.reduce
- Defined in lib/util/Collection.ts:97
reduce<T>(predicate, initialValue): T
Type Parameters
- T
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns T
- initialValue: T
Returns T
Inherited from Collection.reduce
- Defined in lib/util/Collection.ts:98

reduceRight

reduceRight(predicate): Shard
See: Array#reduceRight
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => Shard)
  - - (previousValue, currentValue, currentIndex, array): Shard
    - Parameters
      previousValue: Shard
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns Shard
Returns Shard
Inherited from Collection.reduceRight
- Defined in lib/util/Collection.ts:104
reduceRight(predicate, initialValue): Shard
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => Shard)
  - - (previousValue, currentValue, currentIndex, array): Shard
    - Parameters
      previousValue: Shard
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns Shard
- initialValue: Shard
Returns Shard
Inherited from Collection.reduceRight
- Defined in lib/util/Collection.ts:105
reduceRight<T>(predicate, initialValue): T
Type Parameters
- T
Parameters
- predicate: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: Shard
      currentIndex: number
      array: Shard[]
      Returns T
- initialValue: T
Returns T
Inherited from Collection.reduceRight
- Defined in lib/util/Collection.ts:106

set

set(key, value): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: number
- value: Shard
Returns this
Inherited from Collection.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

some

some<ThisArg>(predicate, thisArg?): boolean
See: Array#some
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: Shard
      index: number
      array: Shard[]
      Returns unknown
- Optional thisArg: ThisArg
Returns boolean
Inherited from Collection.some
- Defined in lib/util/Collection.ts:112

spawn

spawn(id): void
Parameters
- id: number
Returns void
- Defined in lib/gateway/ShardManager.ts:249

toArray

toArray(): Shard[]
Get the values of this collection as an array.

Returns Shard[]
Inherited from Collection.toArray
- Defined in lib/util/Collection.ts:117

tryConnect

tryConnect(): void
Returns void
- Defined in lib/gateway/ShardManager.ts:307

values

values(): IterableIterator<Shard>
Returns an iterable of values in the map

Returns IterableIterator<Shard>
Inherited from Collection.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class ShardManager

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client<ClientEvents>

options: GatewayOptions = {}

Returns ShardManager

Properties

Readonly [toStringTag]

connected

options

Readonly size

Returns

Static Readonly [species]

Accessors

empty

Returns boolean

Methods

[iterator]

Returns IterableIterator<[number, Shard]>

clear

Returns void

connect

Returns Promise<void>

delete

Parameters

key: number

Returns boolean

disconnect

Parameters

reconnect: boolean = ...

Returns void

entries

Returns IterableIterator<[number, Shard]>

every

Type Parameters

T extends Shard

ThisArg = Collection<number, Shard>

Parameters

predicate: ((value, index, array) => value is T)

Parameters

value: Shard

index: number

array: Shard[]

Returns value is T

Optional thisArg: ThisArg

Returns this is T[]

Type Parameters

ThisArg = Collection<number, Shard>

Parameters

predicate: ((value, index, array) => unknown)

Parameters

value: Shard

index: number

array: Shard[]

Returns unknown

Optional thisArg: ThisArg

Returns boolean

filter

Type Parameters

S extends Shard

ThisArg = Collection<number, Shard>

Parameters

predicate: ((this, value, index, array) => value is S)

Parameters

this: ThisArg

value: Shard

index: number

array: Shard[]

Returns value is S

Optional thisArg: ThisArg

Returns S[]

Type Parameters

ThisArg = Collection<number, Shard>

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: unknown

`Optional` thisArg: any