Class TypedCollection<K, M, C, E>

This is an internal class, you should not use it in your projects.

Type Parameters

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

Hierarchy (view full)

Collection<K, C>
- TypedCollection

Index

Constructors

constructor

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

Properties

`Readonly`[toStringTag]

[toStringTag]: string

limit

limit: number

`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:13

Methods

[iterator]

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

Returns IterableIterator<[K, C]>
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

delete

delete(key): boolean
Parameters
- key: K
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

entries

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

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

filter

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

find

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

findIndex

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

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

forEach

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

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: K
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:33

has

has(key): boolean
Parameters
- key: K
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<K>
Returns an iterable of keys in the map

Returns IterableIterator<K>
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:70
last(amount): C[]
Parameters
- amount: number
Returns C[]
Inherited from Collection.last
- Defined in lib/util/Collection.ts:71

map

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

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

reduce

reduce(predicate): C
See: Array#reduce
Parameters
- predicate: ((previousValue: C, currentValue: C, currentIndex: number, array: C[]) => 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:105
reduce(predicate, initialValue): C
Parameters
- predicate: ((previousValue: C, currentValue: C, currentIndex: number, array: C[]) => 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:106
reduce<T>(predicate, initialValue): T
Type Parameters
- T
Parameters
- predicate: ((previousValue: T, currentValue: C, currentIndex: number, array: C[]) => 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:107

reduceRight

reduceRight(predicate): C
See: Array#reduceRight
Parameters
- predicate: ((previousValue: C, currentValue: C, currentIndex: number, array: C[]) => 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:113
reduceRight(predicate, initialValue): C
Parameters
- predicate: ((previousValue: C, currentValue: C, currentIndex: number, array: C[]) => 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:114
reduceRight<T>(predicate, initialValue): T
Type Parameters
- T
Parameters
- predicate: ((previousValue: T, currentValue: C, currentIndex: number, array: C[]) => 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:115

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: K
- value: C
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<K, C>
Parameters
- predicate: ((value: C, index: number, array: C[]) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: C
      index: number
      array: C[]
      Returns unknown
- OptionalthisArg: ThisArg
Returns boolean
Inherited from Collection.some
- Defined in lib/util/Collection.ts:121

toArray

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

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

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

Class TypedCollection<K, M, C, E>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TypedCollection<K, M, C, E>

Properties

Readonly[toStringTag]

limit

Readonlysize

Returns

Static Readonly[species]

Accessors

empty

Returns boolean

Methods

[iterator]

Returns IterableIterator<[K, C]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[K, C]>

every

Type Parameters

Parameters

Parameters

Returns value is T

Returns this is T[]

Type Parameters

Parameters

Parameters

Returns unknown

Returns boolean

filter

Type Parameters

Parameters

Parameters

Returns value is S

Returns S[]

Type Parameters

Parameters

Parameters

Returns unknown

Returns C[]

find

Type Parameters

Parameters

Parameters

Returns value is S

Returns undefined | S

Type Parameters

Parameters

Parameters

Returns unknown

Returns undefined | C

findIndex

Parameters

Parameters

Returns unknown

Returns number

first

Returns undefined | C

Parameters

Returns C[]

forEach

Parameters

Parameters

Returns void

Returns void

get

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]