class LimitedCollection

extends

Collection<Key, Value>
export class LimitedCollection<Key, Value> extends Collection<Key, Value>

A Collection which holds a max amount of entries.

Type Parameters

Key

Value

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

A function called to check if an entry should be kept when the Collection is at max size.

maxSize : number

The max size of the Collection.

external
at(
index: number
) : Value | undefined

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.

Inherited from: Collection

external
clone() : Collection<Key, Value>

Creates an identical shallow copy of this collection.

Examples:
const newColl = someColl.clone();

Inherited from: Collection

staticexternal
combineEntries<

K

V

>(
entries: Iterable<[Key, Value]>
combine: (firstValue: Value, secondValue: Value, key: Key) => Value
) : Collection<Key, Value>

Creates a Collection from a list of entries.

Examples:
Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
// returns Collection { "a" => 3, "b" => 2 }

Inherited from: Collection

external
concat(
...collections: ReadonlyCollection<Key, Value>[]
) : Collection<Key, Value>

Combines this collection with others into a new collection. None of the source collections are modified.

Examples:
const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);

Inherited from: Collection

external
difference<

T

>(
other: ReadonlyCollection<Key, T>
) : Collection<Key, T | Value>

The difference method returns a new structure containing items where the key is present in one of the original structures but not the other.

Inherited from: Collection

external
each(
fn: (value: V, key: K, collection: this) => void
) : this

Identical to Map.forEach(), but returns the collection instead of undefined.

Examples:
collection
 .each(user => console.log(user.username))
 .filter(user => user.bot)
 .each(user => console.log(user.username));

external
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.

Examples:
collection.ensure(guildId, () => defaultGuildConfig);

Inherited from: Collection

external
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.

Returns: Whether the collections have identical contents

Inherited from: Collection

external
every<

K2 extends K

>(
fn: (value: V, key: K, collection: this) => key is K2
) : this is Collection<K2, V>

Checks if all items passes a test. Identical in behavior to Array.every().

Examples:
collection.every(user => !user.bot);

external
filter<

K2 extends K

>(
fn: (value: V, key: K, collection: this) => key is K2
) : Collection<K2, V>

Identical to Array.filter(), but returns a Collection instead of an Array.

Examples:
collection.filter(user => user.username === 'Bob');

external
find<

V2 extends V

>(
fn: (value: V, key: K, collection: this) => value is V2
) : V2 | undefined

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.

Examples:
collection.find(user => user.username === 'Bob');

external
findKey<

K2 extends K

>(
fn: (value: V, key: K, collection: this) => key is K2
) : K2 | undefined

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.

Examples:
collection.findKey(user => user.username === 'Bob');

external
first() : V | undefined

Obtains the first value(s) in this collection.

Returns: A single value if no amount is provided or an array of values, starting from the end if amount is negative

external
firstKey() : K | undefined

Obtains the first key(s) in this collection.

Returns: A single key if no amount is provided or an array of keys, starting from the end if amount is negative

external
flatMap<

T

>(
fn: (value: V, key: K, collection: this) => Collection<K, T>
) : Collection<K, T>

Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to Array.flatMap().

Examples:
collection.flatMap(guild => guild.members.cache);

external
hasAll(
...keys: Key[]
) : boolean

Checks if all of the elements exist in the collection.

Returns: true if all of the elements exist, false if at least one does not exist.

Inherited from: Collection

external
hasAny(
...keys: Key[]
) : boolean

Checks if any of the elements exist in the collection.

Returns: true if any of the elements exist, false if none exist.

Inherited from: Collection

external
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.

Inherited from: Collection

external
keyAt(
index: number
) : Key | undefined

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.

Inherited from: Collection

external
last() : V | undefined

Obtains the last value(s) in this collection.

Returns: A single value if no amount is provided or an array of values, starting from the start if amount is negative

external
lastKey() : K | undefined

Obtains the last key(s) in this collection.

Returns: A single key if no amount is provided or an array of keys, starting from the start if amount is negative

external
map<

T

>(
fn: (value: V, key: K, collection: this) => T
) : T[]

Maps each item to another value into an array. Identical in behavior to Array.map().

Examples:
collection.map(user => user.tag);

external
mapValues<

T

>(
fn: (value: V, key: K, collection: this) => T
) : Collection<K, T>

Maps each item to another value into a collection. Identical in behavior to Array.map().

Examples:
collection.mapValues(user => user.tag);

external
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.

Examples:
// 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 }),
);
// 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

external
partition<

K2 extends K

>(
fn: (value: V, key: K, collection: this) => key is K2
) : [Collection<K2, V>, Collection<Exclude<K, K2>, V>]

Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.

Examples:
const [big, small] = collection.partition(guild => guild.memberCount > 250);

external
random() : V | undefined

Obtains unique random value(s) from this collection.

Returns: A single value if no amount is provided or an array of values

external
randomKey() : K | undefined

Obtains unique random key(s) from this collection.

Returns: A single key if no amount is provided or an array

external
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().

Examples:
collection.reduce((acc, guild) => acc + guild.memberCount, 0);

Inherited from: Collection

external
reverse() : this

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

Inherited from: Collection

external
some(
fn: (value: V, key: K, collection: this) => unknown
) : boolean

Checks if there exists an item that passes a test. Identical in behavior to Array.some().

Examples:
collection.some(user => user.discriminator === '0000');

external
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.

Examples:
collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Inherited from: Collection

external
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.

Examples:
collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Inherited from: Collection

external
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.

Inherited from: Collection

external
sweep(
fn: (value: V, key: K, collection: this) => unknown
) : number

Removes items that satisfy the provided filter function.

Returns: The number of removed entries

external
tap(
fn: (collection: this) => void
) : this

Runs a function on the collection and returns the collection.

Examples:
collection
 .tap(coll => console.log(coll.size))
 .filter(user => user.bot)
 .tap(coll => console.log(coll.size))

external
toJSON() : Value[]

Inherited from: Collection