Class TypedCollection<M, C, E>

This is an internal class, you should not use it in your projects. If you want a collection type for your own projects, look at Collection.

Type Parameters

M extends Record<string, any>
C extends Base
E extends unknown[] = []

Hierarchy

Collection<string, C>
- TypedCollection

Index

Accessors

empty

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

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

Constructors

constructor

new TypedCollection<M, C, E>(baseObject, client, limit?, extraOptions?): TypedCollection<M, C, E>
Type Parameters
- M extends Record<string, any>
- C extends Base
- E extends unknown[] = []
Parameters
- baseObject: AnyClass<M, C, E>
- client: Client<ClientEvents>
- limit: number = Infinity
- Optional extraOptions: ExtraOptions<M, C, E>
Returns TypedCollection<M, C, E>
Overrides Collection.constructor
- Defined in lib/util/TypedCollection.ts:19

Methods

[iterator]

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

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

clear

clear(): void
Returns void
Overrides Collection.clear
- Defined in lib/util/TypedCollection.ts:56

delete

delete(key): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Overrides Collection.delete
- Defined in lib/util/TypedCollection.ts:63

entries

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

Returns IterableIterator<[string, C]>
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 Base
- ThisArg = Collection<string, C>
Parameters
- predicate: ((value, index, array) => value is T)
  - - (value, index, array): value is T
    - Parameters
      
      value: C
      
      index: number
      
      array: C[]
      
      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<string, C>
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      
      value: C
      
      index: number
      
      array: C[]
      
      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 Base
- ThisArg = Collection<string, C>
Parameters
- predicate: ((this, value, index, array) => value is S)
  - - (this, value, index, array): value is S
    - Parameters
      
      this: ThisArg
      
      value: C
      
      index: number
      
      array: C[]
      
      Returns value is S
- Optional thisArg: ThisArg
Returns S[]
Inherited from Collection.filter
- Defined in lib/util/Collection.ts:19
filter<ThisArg>(predicate, thisArg?): C[]
Type Parameters
- ThisArg = Collection<string, C>
Parameters
- predicate: ((this, value, index, array) => unknown)
  - - (this, value, index, array): unknown
    - Parameters
      
      this: ThisArg
      
      value: C
      
      index: number
      
      array: C[]
      
      Returns unknown
- Optional thisArg: ThisArg
Returns C[]
Inherited from Collection.filter
- Defined in lib/util/Collection.ts:20

find

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

findIndex

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

first

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

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

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: C
      
      key: string
      
      map: Map<string, C>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from Collection.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key): undefined | C
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: string
Returns undefined | C
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:34

has

has(key): boolean
Parameters
- key: string
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:38

keys

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

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

last

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

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

map

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

random

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

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

reduce

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

reduceRight

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

set

set(key, value): TypedCollection<M, C, E>
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: string
- value: C
Returns TypedCollection<M, C, E>
Inherited from Collection.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:42

some

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

toArray

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

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

values

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

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

Properties

`Readonly` [toStringTag]

[toStringTag]: string

extraOptions

extraOptions: Required<ExtraOptions<M, C, E>>

limit

limit: number

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Class TypedCollection<M, C, E>

Type Parameters

M extends Record<string, any>

C extends Base

E extends unknown[] = []

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

empty

Returns boolean

Constructors

constructor

Type Parameters

M extends Record<string, any>

C extends Base

E extends unknown[] = []

Parameters

baseObject: AnyClass<M, C, E>

client: Client<ClientEvents>

limit: number = Infinity

Optional extraOptions: ExtraOptions<M, C, E>

Returns TypedCollection<M, C, E>

Methods

[iterator]

Returns IterableIterator<[string, C]>

clear

Returns void

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, C]>

every

Type Parameters

T extends Base

ThisArg = Collection<string, C>

Parameters

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

Parameters

value: C

index: number

array: C[]

Returns value is T

Optional thisArg: ThisArg

Returns this is T[]

Type Parameters

ThisArg = Collection<string, C>

Parameters

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

Parameters

value: C

index: number

array: C[]

Returns unknown

Optional thisArg: ThisArg

Returns boolean

filter

Type Parameters

S extends Base

ThisArg = Collection<string, C>

Parameters

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

Parameters

this: ThisArg

value: C

index: number

array: C[]

Returns value is S

Optional thisArg: ThisArg

Returns S[]

Type Parameters

ThisArg = Collection<string, C>

Parameters

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

Parameters

`Optional` extraOptions: ExtraOptions<M, C, E>

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: unknown

`Optional` thisArg: any