Class ShardManager

A manager for all the client's shards.

Hierarchy

Collection<number, Shard>
- ShardManager

Index

Constructors

constructor

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

Properties

`Readonly` [toStringTag]

[toStringTag]: string

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:121

clear

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

connect

connect(shard: Shard): void
Parameters
- shard: Shard
Returns void
- Defined in lib/gateway/ShardManager.ts:96

delete

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

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:126

every

every<T, ThisArg>(predicate: ((value: Shard, index: number, array: Shard[]) => value is T), thisArg?: ThisArg): this is T[]
See: Array#every
Type Parameters
- T extends Shard<T>
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value: Shard, index: number, array: Shard[]) => value is T)
  - - (value: Shard, index: number, array: Shard[]): 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: ((value: Shard, index: number, array: Shard[]) => unknown), thisArg?: ThisArg): boolean
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value: Shard, index: number, array: Shard[]) => unknown)
  - - (value: Shard, index: number, array: Shard[]): 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: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => value is S), thisArg?: ThisArg): S[]
See: Array#filter
Type Parameters
- S extends Shard<S>
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => value is S)
  - - (this: ThisArg, value: Shard, index: number, array: Shard[]): 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:19
filter<ThisArg>(predicate: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => unknown), thisArg?: ThisArg): Shard[]
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => unknown)
  - - (this: ThisArg, value: Shard, index: number, array: Shard[]): 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:20

find

find<S, ThisArg>(predicate: ((this: ThisArg, value: Shard, index: number, obj: Shard[]) => value is S), thisArg?: ThisArg): undefined | S
See: Array#find
Type Parameters
- S extends Shard<S>
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this: ThisArg, value: Shard, index: number, obj: Shard[]) => value is S)
  - - (this: ThisArg, value: Shard, index: number, obj: Shard[]): 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:26
find<ThisArg>(predicate: ((this: ThisArg, value: Shard, index: number, obj: Shard[]) => unknown), thisArg?: ThisArg): undefined | Shard
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((this: ThisArg, value: Shard, index: number, obj: Shard[]) => unknown)
  - - (this: ThisArg, value: Shard, index: number, obj: Shard[]): 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:27

findIndex

findIndex(predicate: ((value: Shard, index: number, obj: Shard[]) => unknown), thisArg?: unknown): number
See: Array#findIndex
Parameters
- predicate: ((value: Shard, index: number, obj: Shard[]) => unknown)
  - - (value: Shard, index: number, obj: Shard[]): 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:33

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:41
first(amount: number): Shard[]
Parameters
- amount: number
Returns Shard[]
Inherited from Collection.first
- Defined in lib/util/Collection.ts:42

forEach

forEach(callbackfn: ((value: Shard, key: number, map: Map<number, Shard>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: Shard, key: number, map: Map<number, Shard>) => void)
  - - (value: Shard, key: number, map: Map<number, Shard>): 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:31

get

get(key: number): 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.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: number
Returns undefined | Shard
Inherited from Collection.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36

has

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

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:131

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:62
last(amount: number): Shard[]
Parameters
- amount: number
Returns Shard[]
Inherited from Collection.last
- Defined in lib/util/Collection.ts:63

map

map<T>(predicate: ((value: Shard, index: number, obj: Shard[]) => T), thisArg?: unknown): T[]
See: Array#map
Type Parameters
- T
Parameters
- predicate: ((value: Shard, index: number, obj: Shard[]) => T)
  - - (value: Shard, index: number, obj: Shard[]): 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:80

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:87

reduce

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

reduceRight

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

set

set(key: number, value: Shard): ShardManager
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 ShardManager
Inherited from Collection.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:44

some

some<ThisArg>(predicate: ((value: Shard, index: number, array: Shard[]) => unknown), thisArg?: ThisArg): boolean
See: Array#some
Type Parameters
- ThisArg = Collection<number, Shard>
Parameters
- predicate: ((value: Shard, index: number, array: Shard[]) => unknown)
  - - (value: Shard, index: number, array: Shard[]): 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:113

spawn

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

toArray

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

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

tryConnect

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

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:136

Class ShardManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client<ClientEvents>

options: GatewayOptions = {}

Returns ShardManager

Properties

Readonly [toStringTag]

options

Readonly size

Returns

Static Readonly [species]

Accessors

empty

Returns boolean

Methods

[iterator]

Returns IterableIterator<[number, Shard]>

clear

Returns void

connect

Parameters

shard: Shard

Returns void

delete

Returns

Parameters

key: number

Returns boolean

entries

Returns IterableIterator<[number, Shard]>

every

Type Parameters

T extends Shard<T>

ThisArg = Collection<number, Shard>

Parameters

predicate: ((value: Shard, index: number, array: Shard[]) => 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: Shard, index: number, array: Shard[]) => unknown)

Parameters

value: Shard

index: number

array: Shard[]

Returns unknown

Optional thisArg: ThisArg

Returns boolean

filter

Type Parameters

S extends Shard<S>

ThisArg = Collection<number, Shard>

Parameters

predicate: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => 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>

Parameters

predicate: ((this: ThisArg, value: Shard, index: number, array: Shard[]) => unknown)

`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