Class ShardManager

Hierarchy

Collection<Shard>
- ShardManager

Implements

SimpleJSON

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShardManager(client: Client, options: ShardManagerOptions): ShardManager

Overrides Collection.constructor
- Defined in node_modules/eris/index.d.ts:3411
Parameters
- client: Client
- options: ShardManagerOptions
Returns ShardManager

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

baseObject

baseObject: new (...args: any[]) => Shard

Type declaration

- new (...args: any[]): Shard
- Parameters
  - Rest ...args: any[]
  Returns Shard

buckets

buckets: Map<number, number>

connectQueue

connectQueue: Shard[]

connectTimeout

connectTimeout: null | Timer

Optional limit

limit: number

Readonly size

size: number

Static Readonly [Symbol.species]

[Symbol.species]: MapConstructor

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[string | number, Shard]>

Inherited from Collection.[Symbol.iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[string | number, Shard]>

add

add(obj: Shard, extra?: unknown, replace?: boolean): Shard

Inherited from Collection.add
- Defined in node_modules/eris/index.d.ts:2525
Parameters
- obj: Shard
- Optional extra: unknown
- Optional replace: boolean
Returns Shard

clear

clear(): void

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

connect

connect(shard: Shard): void

- Defined in node_modules/eris/index.d.ts:3412
Parameters
- shard: Shard
Returns void

delete

delete(key: string | number): boolean

Inherited from Collection.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: string | number
Returns boolean

entries

entries(): IterableIterator<[string | number, Shard]>

Inherited from Collection.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string | number, Shard]>

every

every(func: (i: Shard) => boolean): boolean

Inherited from Collection.every
- Defined in node_modules/eris/index.d.ts:2526
Parameters
- func: (i: Shard) => boolean
  - - (i: Shard): boolean
    - Parameters
      - i: Shard
      Returns boolean
Returns boolean

filter

filter(func: (i: Shard) => boolean): Shard[]

Inherited from Collection.filter
- Defined in node_modules/eris/index.d.ts:2527
Parameters
- func: (i: Shard) => boolean
  - - (i: Shard): boolean
    - Parameters
      - i: Shard
      Returns boolean
Returns Shard[]

find

find(func: (i: Shard) => boolean): undefined | Shard

Inherited from Collection.find
- Defined in node_modules/eris/index.d.ts:2528
Parameters
- func: (i: Shard) => boolean
  - - (i: Shard): boolean
    - Parameters
      - i: Shard
      Returns boolean
Returns undefined | Shard

forEach

forEach(callbackfn: (value: Shard, key: string | number, map: Map<string | number, Shard>) => void, thisArg?: any): void

Inherited from Collection.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters
- callbackfn: (value: Shard, key: string | number, map: Map<string | number, Shard>) => void
  - - (value: Shard, key: string | number, map: Map<string | number, Shard>): void
    - Parameters
      - value: Shard
      - key: string | number
      - map: Map<string | number, Shard>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string | number): undefined | Shard

Inherited from Collection.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: string | number
Returns undefined | Shard

has

has(key: string | number): boolean

Inherited from Collection.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: string | number
Returns boolean

keys

keys(): IterableIterator<string | number>

Inherited from Collection.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<string | number>

map

map<R>(func: (i: Shard) => R): R[]

Inherited from Collection.map
- Defined in node_modules/eris/index.d.ts:2529
Type parameters
- R
Parameters
- func: (i: Shard) => R
  - - (i: Shard): R
    - Parameters
      - i: Shard
      Returns R
Returns R[]

random

random(): undefined | Shard

Inherited from Collection.random
- Defined in node_modules/eris/index.d.ts:2530
Returns undefined | Shard

reduce

reduce<U>(func: (accumulator: U, val: Shard) => U, initialValue?: U): U

Inherited from Collection.reduce
- Defined in node_modules/eris/index.d.ts:2531
Type parameters
- U
Parameters
- func: (accumulator: U, val: Shard) => U
  - - (accumulator: U, val: Shard): U
    - Parameters
      - accumulator: U
      - val: Shard
      Returns U
- Optional initialValue: U
Returns U

remove

remove(obj: Uncached | Shard): null | Shard

Inherited from Collection.remove
- Defined in node_modules/eris/index.d.ts:2532
Parameters
- obj: Uncached | Shard
Returns null | Shard

set

set(key: string | number, value: Shard): ShardManager

Inherited from Collection.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters
- key: string | number
- value: Shard
Returns ShardManager

some

some(func: (i: Shard) => boolean): boolean

Inherited from Collection.some
- Defined in node_modules/eris/index.d.ts:2533
Parameters
- func: (i: Shard) => boolean
  - - (i: Shard): boolean
    - Parameters
      - i: Shard
      Returns boolean
Returns boolean

spawn

spawn(id: number): void

- Defined in node_modules/eris/index.d.ts:3413
Parameters
- id: number
Returns void

toJSON

toJSON(props?: string[]): JSONCache

Implementation of SimpleJSON.toJSON
- Defined in node_modules/eris/index.d.ts:3416
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

- Defined in node_modules/eris/index.d.ts:3415
Returns string

tryConnect

tryConnect(): void

- Defined in node_modules/eris/index.d.ts:3414
Returns void

update

update(obj: Shard, extra?: unknown, replace?: boolean): Shard

Inherited from Collection.update
- Defined in node_modules/eris/index.d.ts:2534
Parameters
- obj: Shard
- Optional extra: unknown
- Optional replace: boolean
Returns Shard

values

values(): IterableIterator<Shard>

Inherited from Collection.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<Shard>

Generated using TypeDoc