Class LimitedCollection<Key, Value>

A Map with additional utility methods. This is used throughout discord.js rather than Arrays for anything that has an ID, for significantly improved performance and ease-of-use.

Type Parameters

Key
The key type this collection holds
Value
The value type this collection holds

Hierarchy (View Summary)

Collection<Key, Value>
- LimitedCollection

Index

Constructors

constructor

new LimitedCollection<Key, Value>(
options?: LimitedCollectionOptions<Key, Value>,
iterable?: Iterable<readonly [Key, Value]>,
): LimitedCollection<Key, Value>
Type Parameters
- Key
- Value
Parameters
- Optionaloptions: LimitedCollectionOptions<Key, Value>
- Optionaliterable: Iterable<readonly [Key, Value]>
Returns LimitedCollection<Key, Value>
Overrides Collection.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:2295

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

constructor

constructor: CollectionConstructor

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

keepOverLimit

keepOverLimit: null | (value: Value, key: Key, collection: this) => boolean

maxSize

maxSize: number

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Methods

[iterator]

"[iterator]"(): IterableIterator<[Key, Value]>
Returns an iterable of entries in the map.

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

at

at(index: number): undefined | Value
Identical to Array.at(). Returns the item at a given index, allowing for positive and negative integers. Negative integers count back from the last item in the collection.
Parameters
- index: number
  The index of the element to obtain
Returns undefined | Value
Inherited from Collection.at
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:98

clear

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

clone

clone(): Collection<Key, Value>
Creates an identical shallow copy of this collection.

Returns Collection<Key, Value>
Example
```
const newColl = someColl.clone();
```
Inherited from Collection.clone
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:328

concat

concat(...collections: ReadonlyCollection<Key, Value>[]): Collection<Key, Value>
Combines this collection with others into a new collection. None of the source collections are modified.
Parameters
- ...collections: ReadonlyCollection<Key, Value>[]
  Collections to merge
Returns Collection<Key, Value>
Example
```
const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);
```
Inherited from Collection.concat
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:338

delete

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

difference

difference<T>(other: ReadonlyCollection<Key, T>): Collection<Key, Value | T>
The difference method returns a new structure containing items where the key is present in one of the original structures but not the other.
Type Parameters
- T
Parameters
- other: ReadonlyCollection<Key, T>
  The other Collection to filter against
Returns Collection<Key, Value | T>
Inherited from Collection.difference
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:378

each

each(fn: (value: Value, key: Key, collection: this) => void): this
Identical to Map.forEach(), but returns the collection instead of undefined.
Parameters
- fn: (value: Value, key: Key, collection: this) => void
  Function to execute for each element
Returns this
Example
```
collection
 .each(user => console.log(user.username))
 .filter(user => user.bot)
 .each(user => console.log(user.username));
```
Inherited from Collection.each
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:303
each<T>(
fn: (this: T, value: Value, key: Key, collection: this) => void,
thisArg: T,
): this
Identical to Map.forEach(), but returns the collection instead of undefined.
Type Parameters
- T
Parameters
- fn: (this: T, value: Value, key: Key, collection: this) => void
  Function to execute for each element
- thisArg: T
  Value to use as this when executing function
Returns this
Example
```
collection
 .each(user => console.log(user.username))
 .filter(user => user.bot)
 .each(user => console.log(user.username));
```
Inherited from Collection.each
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:304

ensure

ensure(
key: Key,
defaultValueGenerator: (key: Key, collection: this) => Value,
): Value
Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.
Parameters
- key: Key
  The key to get if it exists, or set otherwise
- defaultValueGenerator: (key: Key, collection: this) => Value
  A function that generates the default value
Returns Value
Example
```
collection.ensure(guildId, () => defaultGuildConfig);
```
Inherited from Collection.ensure
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:41

entries

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

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

equals

equals(collection: ReadonlyCollection<Key, Value>): boolean
Checks if this collection shares identical items with another. This is different to checking for equality using equal-signs, because the collections may be different objects, but contain the same data.
Parameters
- collection: ReadonlyCollection<Key, Value>
  Collection to compare with
Returns boolean
Whether the collections have identical contents
Inherited from Collection.equals
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:347

every

every<K2>(
fn: (value: Value, key: Key, collection: this) => key is K2,
): this is Collection<K2, Value>
Checks if all items passes a test. Identical in behavior to Array.every().
Type Parameters
- K2
Parameters
- fn: (value: Value, key: Key, collection: this) => key is K2
  Function used to test (should return a boolean)
Returns this is Collection<K2, Value>
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:269
every<V2>(
fn: (value: Value, key: Key, collection: this) => value is V2,
): this is Collection<Key, V2>
Checks if all items passes a test. Identical in behavior to Array.every().
Type Parameters
- V2
Parameters
- fn: (value: Value, key: Key, collection: this) => value is V2
  Function used to test (should return a boolean)
Returns this is Collection<Key, V2>
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:270
every(fn: (value: Value, key: Key, collection: this) => unknown): boolean
Checks if all items passes a test. Identical in behavior to Array.every().
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
Returns boolean
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:271
every<This, K2>(
fn: (this: This, value: Value, key: Key, collection: this) => key is K2,
thisArg: This,
): this is Collection<K2, Value>
Checks if all items passes a test. Identical in behavior to Array.every().
Type Parameters
- This
- K2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => key is K2
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns this is Collection<K2, Value>
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:272
every<This, V2>(
    fn: (
        this: This,
        value: Value,
        key: Key,
        collection: this,
    ) => value is V2,
    thisArg: This,
): this is Collection<Key, V2>
Checks if all items passes a test. Identical in behavior to Array.every().
Type Parameters
- This
- V2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => value is V2
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns this is Collection<Key, V2>
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:273
every<This>(
fn: (this: This, value: Value, key: Key, collection: this) => unknown,
thisArg: This,
): boolean
Checks if all items passes a test. Identical in behavior to Array.every().
Type Parameters
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns boolean
Example
```
collection.every(user => !user.bot);
```
Inherited from Collection.every
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:274

filter

filter<K2>(
fn: (value: Value, key: Key, collection: this) => key is K2,
): Collection<K2, Value>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type Parameters
- K2
Parameters
- fn: (value: Value, key: Key, collection: this) => key is K2
  The function to test with (should return boolean)
Returns Collection<K2, Value>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:183
filter<V2>(
fn: (value: Value, key: Key, collection: this) => value is V2,
): Collection<Key, V2>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type Parameters
- V2
Parameters
- fn: (value: Value, key: Key, collection: this) => value is V2
  The function to test with (should return boolean)
Returns Collection<Key, V2>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:184
filter(
fn: (value: Value, key: Key, collection: this) => unknown,
): Collection<Key, Value>
Identical to Array.filter(), but returns a Collection instead of an Array.
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
Returns Collection<Key, Value>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:185
filter<This, K2>(
fn: (this: This, value: Value, key: Key, collection: this) => key is K2,
thisArg: This,
): Collection<K2, Value>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type Parameters
- This
- K2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => key is K2
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns Collection<K2, Value>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:186
filter<This, V2>(
    fn: (
        this: This,
        value: Value,
        key: Key,
        collection: this,
    ) => value is V2,
    thisArg: This,
): Collection<Key, V2>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type Parameters
- This
- V2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => value is V2
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns Collection<Key, V2>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:187
filter<This>(
fn: (this: This, value: Value, key: Key, collection: this) => unknown,
thisArg: This,
): Collection<Key, Value>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type Parameters
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns Collection<Key, Value>
Example
```
collection.filter(user => user.username === 'Bob');
```
Inherited from Collection.filter
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:188

find

find<V2>(
fn: (value: Value, key: Key, collection: this) => value is V2,
): undefined | V2
Searches for a single item where the given function returns a truthy value. This behaves like Array.find(). All collections used in Discord.js are mapped using their id property, and if you want to find by id you should use the get method. See MDN for details.
Type Parameters
- V2
Parameters
- fn: (value: Value, key: Key, collection: this) => value is V2
  The function to test with (should return boolean)
Returns undefined | V2
Example
```
collection.find(user => user.username === 'Bob');
```
Inherited from Collection.find
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:142
find(
fn: (value: Value, key: Key, collection: this) => unknown,
): undefined | Value
Searches for a single item where the given function returns a truthy value. This behaves like Array.find(). All collections used in Discord.js are mapped using their id property, and if you want to find by id you should use the get method. See MDN for details.
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
Returns undefined | Value
Example
```
collection.find(user => user.username === 'Bob');
```
Inherited from Collection.find
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:143
find<This, V2>(
    fn: (
        this: This,
        value: Value,
        key: Key,
        collection: this,
    ) => value is V2,
    thisArg: This,
): undefined | V2
Searches for a single item where the given function returns a truthy value. This behaves like Array.find(). All collections used in Discord.js are mapped using their id property, and if you want to find by id you should use the get method. See MDN for details.
Type Parameters
- This
- V2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => value is V2
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns undefined | V2
Example
```
collection.find(user => user.username === 'Bob');
```
Inherited from Collection.find
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:144
find<This>(
fn: (this: This, value: Value, key: Key, collection: this) => unknown,
thisArg: This,
): undefined | Value
Searches for a single item where the given function returns a truthy value. This behaves like Array.find(). All collections used in Discord.js are mapped using their id property, and if you want to find by id you should use the get method. See MDN for details.
Type Parameters
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns undefined | Value
Example
```
collection.find(user => user.username === 'Bob');
```
Inherited from Collection.find
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:145

findKey

findKey<K2>(
fn: (value: Value, key: Key, collection: this) => key is K2,
): undefined | K2
Searches for the key of a single item where the given function returns a truthy value. This behaves like Array.findIndex(), but returns the key rather than the positional index.
Type Parameters
- K2
Parameters
- fn: (value: Value, key: Key, collection: this) => key is K2
  The function to test with (should return boolean)
Returns undefined | K2
Example
```
collection.findKey(user => user.username === 'Bob');
```
Inherited from Collection.findKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:158
findKey(
fn: (value: Value, key: Key, collection: this) => unknown,
): undefined | Key
Searches for the key of a single item where the given function returns a truthy value. This behaves like Array.findIndex(), but returns the key rather than the positional index.
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
Returns undefined | Key
Example
```
collection.findKey(user => user.username === 'Bob');
```
Inherited from Collection.findKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:159
findKey<This, K2>(
fn: (this: This, value: Value, key: Key, collection: this) => key is K2,
thisArg: This,
): undefined | K2
Searches for the key of a single item where the given function returns a truthy value. This behaves like Array.findIndex(), but returns the key rather than the positional index.
Type Parameters
- This
- K2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => key is K2
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns undefined | K2
Example
```
collection.findKey(user => user.username === 'Bob');
```
Inherited from Collection.findKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:160
findKey<This>(
fn: (this: This, value: Value, key: Key, collection: this) => unknown,
thisArg: This,
): undefined | Key
Searches for the key of a single item where the given function returns a truthy value. This behaves like Array.findIndex(), but returns the key rather than the positional index.
Type Parameters
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => unknown
  The function to test with (should return boolean)
- thisArg: This
  Value to use as this when executing function
Returns undefined | Key
Example
```
collection.findKey(user => user.username === 'Bob');
```
Inherited from Collection.findKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:161

first

first(): undefined | Value
Obtains the first value(s) in this collection.

Returns undefined | Value
A single value if no amount is provided or an array of values, starting from the end if amount is negative
Inherited from Collection.first
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:62
first(amount: number): Value[]
Obtains the first value(s) in this collection.
Parameters
- amount: number
  Amount of values to obtain from the beginning
Returns Value[]
A single value if no amount is provided or an array of values, starting from the end if amount is negative
Inherited from Collection.first
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:63

firstKey

firstKey(): undefined | Key
Obtains the first key(s) in this collection.

Returns undefined | Key
A single key if no amount is provided or an array of keys, starting from the end if amount is negative
Inherited from Collection.firstKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:71
firstKey(amount: number): Key[]
Obtains the first key(s) in this collection.
Parameters
- amount: number
  Amount of keys to obtain from the beginning
Returns Key[]
A single key if no amount is provided or an array of keys, starting from the end if amount is negative
Inherited from Collection.firstKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:72

flatMap

flatMap<T>(
fn: (value: Value, key: Key, collection: this) => Collection<Key, T>,
): Collection<Key, T>
Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to Array.flatMap().
Type Parameters
- T
Parameters
- fn: (value: Value, key: Key, collection: this) => Collection<Key, T>
  Function that produces a new Collection
Returns Collection<Key, T>
Example
```
collection.flatMap(guild => guild.members.cache);
```
Inherited from Collection.flatMap
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:217
flatMap<T, This>(
    fn: (
        this: This,
        value: Value,
        key: Key,
        collection: this,
    ) => Collection<Key, T>,
    thisArg: This,
): Collection<Key, T>
Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to Array.flatMap().
Type Parameters
- T
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => Collection<Key, T>
  Function that produces a new Collection
- thisArg: This
  Value to use as this when executing function
Returns Collection<Key, T>
Example
```
collection.flatMap(guild => guild.members.cache);
```
Inherited from Collection.flatMap
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:218

forEach

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

get

get(key: Key): undefined | Value
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: Key
Returns undefined | Value
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: Key): boolean
Parameters
- key: Key
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

hasAll

hasAll(...keys: Key[]): boolean
Checks if all of the elements exist in the collection.
Parameters
- ...keys: Key[]
  The keys of the elements to check for
Returns boolean
true if all of the elements exist, false if at least one does not exist.
Inherited from Collection.hasAll
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:48

hasAny

hasAny(...keys: Key[]): boolean
Checks if any of the elements exist in the collection.
Parameters
- ...keys: Key[]
  The keys of the elements to check for
Returns boolean
true if any of the elements exist, false if none exist.
Inherited from Collection.hasAny
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:55

intersect

intersect<T>(other: ReadonlyCollection<Key, T>): Collection<Key, T>
The intersect method returns a new structure containing items where the keys and values are present in both original structures.
Type Parameters
- T
Parameters
- other: ReadonlyCollection<Key, T>
  The other Collection to filter against
Returns Collection<Key, T>
Inherited from Collection.intersect
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:366

keyAt

keyAt(index: number): undefined | Key
Identical to Array.at(). Returns the key at a given index, allowing for positive and negative integers. Negative integers count back from the last item in the collection.
Parameters
- index: number
  The index of the key to obtain
Returns undefined | Key
Inherited from Collection.keyAt
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:106

keys

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

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

last

last(): undefined | Value
Obtains the last value(s) in this collection.

Returns undefined | Value
A single value if no amount is provided or an array of values, starting from the start if amount is negative
Inherited from Collection.last
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:80
last(amount: number): Value[]
Obtains the last value(s) in this collection.
Parameters
- amount: number
  Amount of values to obtain from the end
Returns Value[]
A single value if no amount is provided or an array of values, starting from the start if amount is negative
Inherited from Collection.last
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:81

lastKey

lastKey(): undefined | Key
Obtains the last key(s) in this collection.

Returns undefined | Key
A single key if no amount is provided or an array of keys, starting from the start if amount is negative
Inherited from Collection.lastKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:89
lastKey(amount: number): Key[]
Obtains the last key(s) in this collection.
Parameters
- amount: number
  Amount of keys to obtain from the end
Returns Key[]
A single key if no amount is provided or an array of keys, starting from the start if amount is negative
Inherited from Collection.lastKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:90

map

map<T>(fn: (value: Value, key: Key, collection: this) => T): T[]
Maps each item to another value into an array. Identical in behavior to Array.map().
Type Parameters
- T
Parameters
- fn: (value: Value, key: Key, collection: this) => T
  Function that produces an element of the new array, taking three arguments
Returns T[]
Example
```
collection.map(user => user.tag);
```
Inherited from Collection.map
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:230
map<This, T>(
fn: (this: This, value: Value, key: Key, collection: this) => T,
thisArg: This,
): T[]
Maps each item to another value into an array. Identical in behavior to Array.map().
Type Parameters
- This
- T
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => T
  Function that produces an element of the new array, taking three arguments
- thisArg: This
  Value to use as this when executing function
Returns T[]
Example
```
collection.map(user => user.tag);
```
Inherited from Collection.map
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:231

mapValues

mapValues<T>(
fn: (value: Value, key: Key, collection: this) => T,
): Collection<Key, T>
Maps each item to another value into a collection. Identical in behavior to Array.map().
Type Parameters
- T
Parameters
- fn: (value: Value, key: Key, collection: this) => T
  Function that produces an element of the new collection, taking three arguments
Returns Collection<Key, T>
Example
```
collection.mapValues(user => user.tag);
```
Inherited from Collection.mapValues
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:243
mapValues<This, T>(
fn: (this: This, value: Value, key: Key, collection: this) => T,
thisArg: This,
): Collection<Key, T>
Maps each item to another value into a collection. Identical in behavior to Array.map().
Type Parameters
- This
- T
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => T
  Function that produces an element of the new collection, taking three arguments
- thisArg: This
  Value to use as this when executing function
Returns Collection<Key, T>
Example
```
collection.mapValues(user => user.tag);
```
Inherited from Collection.mapValues
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:244

merge

merge<T, R>(
    other: ReadonlyCollection<Key, T>,
    whenInSelf: (value: Value, key: Key) => Keep<R>,
    whenInOther: (valueOther: T, key: Key) => Keep<R>,
    whenInBoth: (value: Value, valueOther: T, key: Key) => Keep<R>,
): Collection<Key, R>
Merges two Collections together into a new Collection.
Type Parameters
- T
- R
Parameters
- other: ReadonlyCollection<Key, T>
  The other Collection to merge with
- whenInSelf: (value: Value, key: Key) => Keep<R>
  Function getting the result if the entry only exists in this Collection
- whenInOther: (valueOther: T, key: Key) => Keep<R>
  Function getting the result if the entry only exists in the other Collection
- whenInBoth: (value: Value, valueOther: T, key: Key) => Keep<R>
  Function getting the result if the entry exists in both Collections
Returns Collection<Key, R>
Example
```
// Sums up the entries in two collections.
coll.merge(
 other,
 x => ({ keep: true, value: x }),
 y => ({ keep: true, value: y }),
 (x, y) => ({ keep: true, value: x + y }),
);
```
Example
```
// Intersects two collections in a left-biased manner.
coll.merge(
 other,
 x => ({ keep: false }),
 y => ({ keep: false }),
 (x, _) => ({ keep: true, value: x }),
);
```
Inherited from Collection.merge
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:407

partition

partition<K2>(
fn: (value: Value, key: Key, collection: this) => key is K2,
): [Collection<K2, Value>, Collection<Exclude<Key, K2>, Value>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Type Parameters
- K2
Parameters
- fn: (value: Value, key: Key, collection: this) => key is K2
  Function used to test (should return a boolean)
Returns [Collection<K2, Value>, Collection<Exclude<Key, K2>, Value>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:200
partition<V2>(
fn: (value: Value, key: Key, collection: this) => value is V2,
): [Collection<Key, V2>, Collection<Key, Exclude<Value, V2>>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Type Parameters
- V2
Parameters
- fn: (value: Value, key: Key, collection: this) => value is V2
  Function used to test (should return a boolean)
Returns [Collection<Key, V2>, Collection<Key, Exclude<Value, V2>>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:201
partition(
fn: (value: Value, key: Key, collection: this) => unknown,
): [Collection<Key, Value>, Collection<Key, Value>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
Returns [Collection<Key, Value>, Collection<Key, Value>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:202
partition<This, K2>(
fn: (this: This, value: Value, key: Key, collection: this) => key is K2,
thisArg: This,
): [Collection<K2, Value>, Collection<Exclude<Key, K2>, Value>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Type Parameters
- This
- K2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => key is K2
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns [Collection<K2, Value>, Collection<Exclude<Key, K2>, Value>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:203
partition<This, V2>(
    fn: (
        this: This,
        value: Value,
        key: Key,
        collection: this,
    ) => value is V2,
    thisArg: This,
): [Collection<Key, V2>, Collection<Key, Exclude<Value, V2>>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Type Parameters
- This
- V2
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => value is V2
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns [Collection<Key, V2>, Collection<Key, Exclude<Value, V2>>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:204
partition<This>(
fn: (this: This, value: Value, key: Key, collection: this) => unknown,
thisArg: This,
): [Collection<Key, Value>, Collection<Key, Value>]
Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Type Parameters
- This
Parameters
- fn: (this: This, value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
- thisArg: This
  Value to use as this when executing function
Returns [Collection<Key, Value>, Collection<Key, Value>]
Example
```
const [big, small] = collection.partition(guild => guild.memberCount > 250);
```
Inherited from Collection.partition
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:205

random

random(): undefined | Value
Obtains unique random value(s) from this collection.

Returns undefined | Value
A single value if no amount is provided or an array of values
Inherited from Collection.random
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:113
random(amount: number): Value[]
Obtains unique random value(s) from this collection.
Parameters
- amount: number
  Amount of values to obtain randomly
Returns Value[]
A single value if no amount is provided or an array of values
Inherited from Collection.random
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:114

randomKey

randomKey(): undefined | Key
Obtains unique random key(s) from this collection.

Returns undefined | Key
A single key if no amount is provided or an array
Inherited from Collection.randomKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:121
randomKey(amount: number): Key[]
Obtains unique random key(s) from this collection.
Parameters
- amount: number
  Amount of keys to obtain randomly
Returns Key[]
A single key if no amount is provided or an array
Inherited from Collection.randomKey
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:122

reduce

reduce<T = Value>(
fn: (accumulator: T, value: Value, key: Key, collection: this) => T,
initialValue?: T,
): T
Applies a function to produce a single value. Identical in behavior to Array.reduce().
Type Parameters
- T = Value
Parameters
- fn: (accumulator: T, value: Value, key: Key, collection: this) => T
  Function used to reduce, taking four arguments; accumulator, currentValue, currentKey, and collection
- OptionalinitialValue: T
  Starting value for the accumulator
Returns T
Example
```
collection.reduce((acc, guild) => acc + guild.memberCount, 0);
```
Inherited from Collection.reduce
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:287

reverse

reverse(): this
Identical to Array.reverse() but returns a Collection instead of an Array.

Returns this
Inherited from Collection.reverse
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:127

set

set(key: Key, value: 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: Key
- value: Value
Returns this
Inherited from Collection.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

some

some(fn: (value: Value, key: Key, collection: this) => unknown): boolean
Checks if there exists an item that passes a test. Identical in behavior to Array.some().
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
Returns boolean
Example
```
collection.some(user => user.discriminator === '0000');
```
Inherited from Collection.some
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:256
some<T>(
fn: (this: T, value: Value, key: Key, collection: this) => unknown,
thisArg: T,
): boolean
Checks if there exists an item that passes a test. Identical in behavior to Array.some().
Type Parameters
- T
Parameters
- fn: (this: T, value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
- thisArg: T
  Value to use as this when executing function
Returns boolean
Example
```
collection.some(user => user.discriminator === '0000');
```
Inherited from Collection.some
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:257

sort

sort(compareFunction?: Comparator<Key, Value>): this
The sort method sorts the items of a collection in place and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.
Parameters
- OptionalcompareFunction: Comparator<Key, Value>
  Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.
Returns this
Example
```
collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);
```
Inherited from Collection.sort
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:360

sorted

sorted(compareFunction?: Comparator<Key, Value>): Collection<Key, Value>
The sorted method sorts the items of a collection and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.
Parameters
- OptionalcompareFunction: Comparator<Key, Value>
  Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.
Returns Collection<Key, Value>
Example
```
collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);
```
Inherited from Collection.sorted
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:421

subtract

subtract<T>(other: ReadonlyCollection<Key, T>): Collection<Key, Value>
The subtract method returns a new structure containing items where the keys and values of the original structure are not present in the other.
Type Parameters
- T
Parameters
- other: ReadonlyCollection<Key, T>
  The other Collection to filter against
Returns Collection<Key, Value>
Inherited from Collection.subtract
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:372

sweep

sweep(fn: (value: Value, key: Key, collection: this) => unknown): number
Removes items that satisfy the provided filter function.
Parameters
- fn: (value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
Returns number
The number of removed entries
Inherited from Collection.sweep
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:169
sweep<T>(
fn: (this: T, value: Value, key: Key, collection: this) => unknown,
thisArg: T,
): number
Removes items that satisfy the provided filter function.
Type Parameters
- T
Parameters
- fn: (this: T, value: Value, key: Key, collection: this) => unknown
  Function used to test (should return a boolean)
- thisArg: T
  Value to use as this when executing function
Returns number
The number of removed entries
Inherited from Collection.sweep
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:170

tap

tap(fn: (collection: this) => void): this
Runs a function on the collection and returns the collection.
Parameters
- fn: (collection: this) => void
  Function to execute
Returns this
Example
```
collection
 .tap(coll => console.log(coll.size))
 .filter(user => user.bot)
 .tap(coll => console.log(coll.size))
```
Inherited from Collection.tap
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:318
tap<T>(fn: (this: T, collection: this) => void, thisArg: T): this
Runs a function on the collection and returns the collection.
Type Parameters
- T
Parameters
- fn: (this: T, collection: this) => void
  Function to execute
- thisArg: T
  Value to use as this when executing function
Returns this
Example
```
collection
 .tap(coll => console.log(coll.size))
 .filter(user => user.bot)
 .tap(coll => console.log(coll.size))
```
Inherited from Collection.tap
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:319

toJSON

toJSON(): Value[]
Returns Value[]
Inherited from Collection.toJSON
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:422

values

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

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

`Static`combineEntries

combineEntries<K, V>(
entries: Iterable<[K, V]>,
combine: (firstValue: V, secondValue: V, key: K) => V,
): Collection<K, V>
Creates a Collection from a list of entries.
Type Parameters
- K
- V
Parameters
- entries: Iterable<[K, V]>
  The list of entries
- combine: (firstValue: V, secondValue: V, key: K) => V
  Function to combine an existing entry with a new one
Returns Collection<K, V>
Example
```
Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
// returns Collection { "a" => 3, "b" => 2 }
```
Inherited from Collection.combineEntries
- Defined in node_modules/@discordjs/collection/dist/index.d.ts:435

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Collection.groupBy
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:25

Class LimitedCollection<Key, Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LimitedCollection<Key, Value>

Properties

Readonly[toStringTag]

constructor

keepOverLimit

maxSize

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns IterableIterator<[Key, Value]>

at

Parameters

Returns undefined | Value

clear

Returns void

clone

Returns Collection<Key, Value>

Example

concat

Parameters

Returns Collection<Key, Value>

Example

delete

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns Collection<Key, Value | T>

each

Parameters

Returns this

Example

Type Parameters

Parameters

Returns this

Example

ensure

Parameters

Returns Value

Example

entries

Returns IterableIterator<[Key, Value]>

equals

Parameters

Returns boolean

every

Type Parameters

Parameters

Returns this is Collection<K2, Value>

Example

Type Parameters

Parameters

Returns this is Collection<Key, V2>

Example

Parameters

Returns boolean

Example

Type Parameters

Parameters

Returns this is Collection<K2, Value>

Example

Type Parameters

Parameters

Returns this is Collection<Key, V2>

Example

Type Parameters

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]