class LimitedCollection
extends
Collection<Key, Value>export class LimitedCollection<Key, Value> extends Collection<Key, Value>A Collection which holds a max amount of entries.
Constructors
Type Parameters
Key
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.
Inherited from: Collection
clone() : Collection<Key, Value>
Creates an identical shallow copy of this collection.
const newColl = someColl.clone();Inherited from: Collection
static combineEntries<Key
Value
>() : Collection<Key, Value>
Key
Value
Creates a Collection from a list of entries.
Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
// returns Collection { "a" => 3, "b" => 2 }Inherited from: Collection
concat(...collections: ReadonlyCollection<Key, Value>[]) : Collection<Key, Value>
Combines this collection with others into a new collection. None of the source collections are modified.
const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);Inherited from: Collection
difference(other: ReadonlyCollection<Key, any>) : Collection<Key, Value>
Returns a new collection containing the items where the key is present in this collection but not the other.
const col1 = new Collection([['a', 1], ['b', 2]]);
const col2 = new Collection([['a', 1], ['c', 3]]);
console.log(col1.difference(col2));
// => Collection { 'b' => 2 }
console.log(col2.difference(col1));
// => Collection { 'c' => 3 }Inherited from: Collection
Identical toMap.forEach(),but returns the collection instead of undefined.
collection
.each(user => console.log(user.username))
.filter(user => user.bot)
.each(user => console.log(user.username));Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.
collection.ensure(guildId, () => defaultGuildConfig);Inherited from: Collection
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, becausethe collections may be different objects, but contain the same data.
Returns: Whether the collections have identical contents
Inherited from: Collection
every<NewKey extends Key
>() : this is Collection<NewKey, Value>
NewKey extends Key
Checks if all items passes a test. Identical in behavior toArray.every().
collection.every(user => !user.bot); filter<NewKey extends Key
>() : Collection<NewKey, Value>
NewKey extends Key
Identical toArray.filter(),but returns a Collection instead of an Array.
collection.filter(user => user.username === 'Bob'); find<NewValue extends Value
>() : NewValue | undefined
NewValue extends Value
Searches for a single item where the given function returns a truthy value. This behaves likeArray.find().All collections used in Discord.js are mapped using their id property, and if you want to find by id youshould use the get method. SeeMDN for details.
collection.find(user => user.username === 'Bob'); findKey<NewKey extends Key
>() : NewKey | undefined
NewKey extends Key
Searches for the key of a single item where the given function returns a truthy value. This behaves likeArray.findIndex(),but returns the key rather than the positional index.
collection.findKey(user => user.username === 'Bob'); findLast<NewValue extends Value
>() : NewValue | undefined
NewValue extends Value
Searches for a last item where the given function returns a truthy value. This behaves likeArray.findLast().
findLastKey<NewKey extends Key
>() : NewKey | undefined
NewKey extends Key
Searches for the key of a last item where the given function returns a truthy value. This behaves likeArray.findLastIndex(),but returns the key rather than the positional index.
flatMap<NewValue
>(fn: (value: Value, key: Key, collection: this) => Collection<Key, NewValue>) : Collection<Key, NewValue>
NewValue
Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior toArray.flatMap().
collection.flatMap(guild => guild.members.cache);static groupBy<Key
Item
>() : Collection<Key, Item[]>
Key
Item
Identical to Map.groupBy()but returns a Collection instead of a Map.
Inherited from: Collection
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
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
intersection(other: ReadonlyCollection<Key, any>) : Collection<Key, Value>
The intersection method returns a new collection containing the items where the key is present in both collections.
const col1 = new Collection([['a', 1], ['b', 2]]);
const col2 = new Collection([['a', 1], ['c', 3]]);
const intersection = col1.intersection(col2);
console.log(col1.intersection(col2));
// => Collection { 'a' => 1 }Inherited from: Collection
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
Maps each item to another value into an array. Identical in behavior toArray.map().
collection.map(user => user.tag); mapValues<NewValue
>() : Collection<Key, NewValue>
NewValue
Maps each item to another value into a collection. Identical in behavior toArray.map().
collection.mapValues(user => user.tag); merge<OtherValue
ResultValue
>(other: ReadonlyCollection<Key, OtherValue>) : Collection<Key, ResultValue>
OtherValue
ResultValue
Merges two Collections together into a new Collection.
// 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
partition<NewKey extends Key
>() : [Collection<NewKey, Value>, Collection<Exclude<Key, NewKey>, Value>]
NewKey extends Key
Partitions the collection into two collections where the first collectioncontains the items that passed and the second contains the items that failed.
const [big, small] = collection.partition(guild => guild.memberCount > 250);Identical to Array.reverse()but returns a Collection instead of an Array.
Inherited from: Collection
Checks if there exists an item that passes a test. Identical in behavior toArray.some().
collection.some(user => user.discriminator === '0000'); sort(compareFunction?: Comparator<Key, Value>) : this
The sort method sorts the items of a collection in place and returns it.If a comparison function is not provided, the function sorts by element values, using the same stringwise comparison algorithm asArray.sort().
collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);Inherited from: Collection
symmetricDifference<OtherValue
>(other: ReadonlyCollection<Key, OtherValue>) : Collection<Key, OtherValue | Value>
OtherValue
Returns a new collection containing only the items where the keys are present in either collection, but not both.
const col1 = new Collection([['a', 1], ['b', 2]]);
const col2 = new Collection([['a', 1], ['c', 3]]);
const symmetricDifference = col1.symmetricDifference(col2);
console.log(col1.symmetricDifference(col2));
// => Collection { 'b' => 2, 'c' => 3 }Inherited from: Collection
tap(fn: (collection: this) => void) : this
Runs a function on the collection and returns the collection.
collection
.tap(coll => console.log(coll.size))
.filter(user => user.bot)
.tap(coll => console.log(coll.size))Inherited from: Collection
toReversed() : Collection<Key, Value>
Identical to Array.toReversed()but returns a Collection instead of an Array.
Inherited from: Collection
toSorted(compareFunction?: Comparator<Key, Value>) : Collection<Key, Value>
The toSorted method returns a shallow copy of the collection with the items sorted.If a comparison function is not provided, the function sorts by element values, using the same stringwise comparison algorithm asArray.sort().
const sortedCollection = collection.toSorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);Inherited from: Collection
union<OtherValue
>(other: ReadonlyCollection<Key, OtherValue>) : Collection<Key, OtherValue | Value>
OtherValue
Returns a new collection containing the items where the key is present in either of the collections.
const col1 = new Collection([['a', 1], ['b', 2]]);
const col2 = new Collection([['a', 1], ['b', 3], ['c', 3]]);
const union = col1.union(col2);
console.log(union);
// => Collection { 'a' => 1, 'b' => 2, 'c' => 3 }Inherited from: Collection