522 lines
16 KiB
JavaScript
522 lines
16 KiB
JavaScript
|
var __defProp = Object.defineProperty;
|
||
|
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
||
|
|
|
||
|
|
// src/collection.ts
|
||
|
|
var Collection = class extends Map {
|
||
|
|
/**
|
||
|
|
* Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.
|
||
|
|
*
|
||
|
|
* @param key - The key to get if it exists, or set otherwise
|
||
|
|
* @param defaultValueGenerator - A function that generates the default value
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* collection.ensure(guildId, () => defaultGuildConfig);
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
ensure(key, defaultValueGenerator) {
|
||
|
|
if (this.has(key))
|
||
|
|
return this.get(key);
|
||
|
|
if (typeof defaultValueGenerator !== "function")
|
||
|
|
throw new TypeError(`${defaultValueGenerator} is not a function`);
|
||
|
|
const defaultValue = defaultValueGenerator(key, this);
|
||
|
|
this.set(key, defaultValue);
|
||
|
|
return defaultValue;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Checks if all of the elements exist in the collection.
|
||
|
|
*
|
||
|
|
* @param keys - The keys of the elements to check for
|
||
|
|
* @returns `true` if all of the elements exist, `false` if at least one does not exist.
|
||
|
|
*/
|
||
|
|
hasAll(...keys) {
|
||
|
|
return keys.every((key) => super.has(key));
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Checks if any of the elements exist in the collection.
|
||
|
|
*
|
||
|
|
* @param keys - The keys of the elements to check for
|
||
|
|
* @returns `true` if any of the elements exist, `false` if none exist.
|
||
|
|
*/
|
||
|
|
hasAny(...keys) {
|
||
|
|
return keys.some((key) => super.has(key));
|
||
|
|
}
|
||
|
|
first(amount) {
|
||
|
|
if (amount === void 0)
|
||
|
|
return this.values().next().value;
|
||
|
|
if (amount < 0)
|
||
|
|
return this.last(amount * -1);
|
||
|
|
amount = Math.min(this.size, amount);
|
||
|
|
const iter = this.values();
|
||
|
|
return Array.from({ length: amount }, () => iter.next().value);
|
||
|
|
}
|
||
|
|
firstKey(amount) {
|
||
|
|
if (amount === void 0)
|
||
|
|
return this.keys().next().value;
|
||
|
|
if (amount < 0)
|
||
|
|
return this.lastKey(amount * -1);
|
||
|
|
amount = Math.min(this.size, amount);
|
||
|
|
const iter = this.keys();
|
||
|
|
return Array.from({ length: amount }, () => iter.next().value);
|
||
|
|
}
|
||
|
|
last(amount) {
|
||
|
|
const arr = [...this.values()];
|
||
|
|
if (amount === void 0)
|
||
|
|
return arr[arr.length - 1];
|
||
|
|
if (amount < 0)
|
||
|
|
return this.first(amount * -1);
|
||
|
|
if (!amount)
|
||
|
|
return [];
|
||
|
|
return arr.slice(-amount);
|
||
|
|
}
|
||
|
|
lastKey(amount) {
|
||
|
|
const arr = [...this.keys()];
|
||
|
|
if (amount === void 0)
|
||
|
|
return arr[arr.length - 1];
|
||
|
|
if (amount < 0)
|
||
|
|
return this.firstKey(amount * -1);
|
||
|
|
if (!amount)
|
||
|
|
return [];
|
||
|
|
return arr.slice(-amount);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Identical to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at | 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.
|
||
|
|
*
|
||
|
|
* @param index - The index of the element to obtain
|
||
|
|
*/
|
||
|
|
at(index) {
|
||
|
|
index = Math.floor(index);
|
||
|
|
const arr = [...this.values()];
|
||
|
|
return arr.at(index);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Identical to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at | 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.
|
||
|
|
*
|
||
|
|
* @param index - The index of the key to obtain
|
||
|
|
*/
|
||
|
|
keyAt(index) {
|
||
|
|
index = Math.floor(index);
|
||
|
|
const arr = [...this.keys()];
|
||
|
|
return arr.at(index);
|
||
|
|
}
|
||
|
|
random(amount) {
|
||
|
|
const arr = [...this.values()];
|
||
|
|
if (amount === void 0)
|
||
|
|
return arr[Math.floor(Math.random() * arr.length)];
|
||
|
|
if (!arr.length || !amount)
|
||
|
|
return [];
|
||
|
|
return Array.from(
|
||
|
|
{ length: Math.min(amount, arr.length) },
|
||
|
|
() => arr.splice(Math.floor(Math.random() * arr.length), 1)[0]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
randomKey(amount) {
|
||
|
|
const arr = [...this.keys()];
|
||
|
|
if (amount === void 0)
|
||
|
|
return arr[Math.floor(Math.random() * arr.length)];
|
||
|
|
if (!arr.length || !amount)
|
||
|
|
return [];
|
||
|
|
return Array.from(
|
||
|
|
{ length: Math.min(amount, arr.length) },
|
||
|
|
() => arr.splice(Math.floor(Math.random() * arr.length), 1)[0]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Identical to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse | Array.reverse()}
|
||
|
|
* but returns a Collection instead of an Array.
|
||
|
|
*/
|
||
|
|
reverse() {
|
||
|
|
const entries = [...this.entries()].reverse();
|
||
|
|
this.clear();
|
||
|
|
for (const [key, value] of entries)
|
||
|
|
this.set(key, value);
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
find(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this))
|
||
|
|
return val;
|
||
|
|
}
|
||
|
|
return void 0;
|
||
|
|
}
|
||
|
|
findKey(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this))
|
||
|
|
return key;
|
||
|
|
}
|
||
|
|
return void 0;
|
||
|
|
}
|
||
|
|
sweep(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
const previousSize = this.size;
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this))
|
||
|
|
this.delete(key);
|
||
|
|
}
|
||
|
|
return previousSize - this.size;
|
||
|
|
}
|
||
|
|
filter(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
const results = new this.constructor[Symbol.species]();
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this))
|
||
|
|
results.set(key, val);
|
||
|
|
}
|
||
|
|
return results;
|
||
|
|
}
|
||
|
|
partition(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
const results = [
|
||
|
|
new this.constructor[Symbol.species](),
|
||
|
|
new this.constructor[Symbol.species]()
|
||
|
|
];
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this)) {
|
||
|
|
results[0].set(key, val);
|
||
|
|
} else {
|
||
|
|
results[1].set(key, val);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return results;
|
||
|
|
}
|
||
|
|
flatMap(fn, thisArg) {
|
||
|
|
const collections = this.map(fn, thisArg);
|
||
|
|
return new this.constructor[Symbol.species]().concat(...collections);
|
||
|
|
}
|
||
|
|
map(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
const iter = this.entries();
|
||
|
|
return Array.from({ length: this.size }, () => {
|
||
|
|
const [key, value] = iter.next().value;
|
||
|
|
return fn(value, key, this);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
mapValues(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
const coll = new this.constructor[Symbol.species]();
|
||
|
|
for (const [key, val] of this)
|
||
|
|
coll.set(key, fn(val, key, this));
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
some(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (fn(val, key, this))
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
every(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (!fn(val, key, this))
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Applies a function to produce a single value. Identical in behavior to
|
||
|
|
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce | Array.reduce()}.
|
||
|
|
*
|
||
|
|
* @param fn - Function used to reduce, taking four arguments; `accumulator`, `currentValue`, `currentKey`,
|
||
|
|
* and `collection`
|
||
|
|
* @param initialValue - Starting value for the accumulator
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* collection.reduce((acc, guild) => acc + guild.memberCount, 0);
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
reduce(fn, initialValue) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
let accumulator;
|
||
|
|
if (initialValue !== void 0) {
|
||
|
|
accumulator = initialValue;
|
||
|
|
for (const [key, val] of this)
|
||
|
|
accumulator = fn(accumulator, val, key, this);
|
||
|
|
return accumulator;
|
||
|
|
}
|
||
|
|
let first = true;
|
||
|
|
for (const [key, val] of this) {
|
||
|
|
if (first) {
|
||
|
|
accumulator = val;
|
||
|
|
first = false;
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
accumulator = fn(accumulator, val, key, this);
|
||
|
|
}
|
||
|
|
if (first) {
|
||
|
|
throw new TypeError("Reduce of empty collection with no initial value");
|
||
|
|
}
|
||
|
|
return accumulator;
|
||
|
|
}
|
||
|
|
each(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
for (const [key, value] of this) {
|
||
|
|
fn(value, key, this);
|
||
|
|
}
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
tap(fn, thisArg) {
|
||
|
|
if (typeof fn !== "function")
|
||
|
|
throw new TypeError(`${fn} is not a function`);
|
||
|
|
if (thisArg !== void 0)
|
||
|
|
fn = fn.bind(thisArg);
|
||
|
|
fn(this);
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Creates an identical shallow copy of this collection.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* const newColl = someColl.clone();
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
clone() {
|
||
|
|
return new this.constructor[Symbol.species](this);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Combines this collection with others into a new collection. None of the source collections are modified.
|
||
|
|
*
|
||
|
|
* @param collections - Collections to merge
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
concat(...collections) {
|
||
|
|
const newColl = this.clone();
|
||
|
|
for (const coll of collections) {
|
||
|
|
for (const [key, val] of coll)
|
||
|
|
newColl.set(key, val);
|
||
|
|
}
|
||
|
|
return newColl;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param collection - Collection to compare with
|
||
|
|
* @returns Whether the collections have identical contents
|
||
|
|
*/
|
||
|
|
equals(collection) {
|
||
|
|
if (!collection)
|
||
|
|
return false;
|
||
|
|
if (this === collection)
|
||
|
|
return true;
|
||
|
|
if (this.size !== collection.size)
|
||
|
|
return false;
|
||
|
|
for (const [key, value] of this) {
|
||
|
|
if (!collection.has(key) || value !== collection.get(key)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param compareFunction - 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.
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
sort(compareFunction = Collection.defaultSort) {
|
||
|
|
const entries = [...this.entries()];
|
||
|
|
entries.sort((a, b) => compareFunction(a[1], b[1], a[0], b[0]));
|
||
|
|
super.clear();
|
||
|
|
for (const [key, value] of entries) {
|
||
|
|
super.set(key, value);
|
||
|
|
}
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The intersect method returns a new structure containing items where the keys and values are present in both original structures.
|
||
|
|
*
|
||
|
|
* @param other - The other Collection to filter against
|
||
|
|
*/
|
||
|
|
intersect(other) {
|
||
|
|
const coll = new this.constructor[Symbol.species]();
|
||
|
|
for (const [key, value] of other) {
|
||
|
|
if (this.has(key) && Object.is(value, this.get(key))) {
|
||
|
|
coll.set(key, value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The subtract method returns a new structure containing items where the keys and values of the original structure are not present in the other.
|
||
|
|
*
|
||
|
|
* @param other - The other Collection to filter against
|
||
|
|
*/
|
||
|
|
subtract(other) {
|
||
|
|
const coll = new this.constructor[Symbol.species]();
|
||
|
|
for (const [key, value] of this) {
|
||
|
|
if (!other.has(key) || !Object.is(value, other.get(key))) {
|
||
|
|
coll.set(key, value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The difference method returns a new structure containing items where the key is present in one of the original structures but not the other.
|
||
|
|
*
|
||
|
|
* @param other - The other Collection to filter against
|
||
|
|
*/
|
||
|
|
difference(other) {
|
||
|
|
const coll = new this.constructor[Symbol.species]();
|
||
|
|
for (const [key, value] of other) {
|
||
|
|
if (!this.has(key))
|
||
|
|
coll.set(key, value);
|
||
|
|
}
|
||
|
|
for (const [key, value] of this) {
|
||
|
|
if (!other.has(key))
|
||
|
|
coll.set(key, value);
|
||
|
|
}
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Merges two Collections together into a new Collection.
|
||
|
|
*
|
||
|
|
* @param other - The other Collection to merge with
|
||
|
|
* @param whenInSelf - Function getting the result if the entry only exists in this Collection
|
||
|
|
* @param whenInOther - Function getting the result if the entry only exists in the other Collection
|
||
|
|
* @param whenInBoth - Function getting the result if the entry exists in both Collections
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* // 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
|
||
|
|
* ```ts
|
||
|
|
* // Intersects two collections in a left-biased manner.
|
||
|
|
* coll.merge(
|
||
|
|
* other,
|
||
|
|
* x => ({ keep: false }),
|
||
|
|
* y => ({ keep: false }),
|
||
|
|
* (x, _) => ({ keep: true, value: x }),
|
||
|
|
* );
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
merge(other, whenInSelf, whenInOther, whenInBoth) {
|
||
|
|
const coll = new this.constructor[Symbol.species]();
|
||
|
|
const keys = /* @__PURE__ */ new Set([...this.keys(), ...other.keys()]);
|
||
|
|
for (const key of keys) {
|
||
|
|
const hasInSelf = this.has(key);
|
||
|
|
const hasInOther = other.has(key);
|
||
|
|
if (hasInSelf && hasInOther) {
|
||
|
|
const result = whenInBoth(this.get(key), other.get(key), key);
|
||
|
|
if (result.keep)
|
||
|
|
coll.set(key, result.value);
|
||
|
|
} else if (hasInSelf) {
|
||
|
|
const result = whenInSelf(this.get(key), key);
|
||
|
|
if (result.keep)
|
||
|
|
coll.set(key, result.value);
|
||
|
|
} else if (hasInOther) {
|
||
|
|
const result = whenInOther(other.get(key), key);
|
||
|
|
if (result.keep)
|
||
|
|
coll.set(key, result.value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param compareFunction - 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.
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
sorted(compareFunction = Collection.defaultSort) {
|
||
|
|
return new this.constructor[Symbol.species](this).sort((av, bv, ak, bk) => compareFunction(av, bv, ak, bk));
|
||
|
|
}
|
||
|
|
toJSON() {
|
||
|
|
return [...this.values()];
|
||
|
|
}
|
||
|
|
static defaultSort(firstValue, secondValue) {
|
||
|
|
return Number(firstValue > secondValue) || Number(firstValue === secondValue) - 1;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Creates a Collection from a list of entries.
|
||
|
|
*
|
||
|
|
* @param entries - The list of entries
|
||
|
|
* @param combine - Function to combine an existing entry with a new one
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
|
||
|
|
* // returns Collection { "a" => 3, "b" => 2 }
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
static combineEntries(entries, combine) {
|
||
|
|
const coll = new Collection();
|
||
|
|
for (const [key, value] of entries) {
|
||
|
|
if (coll.has(key)) {
|
||
|
|
coll.set(key, combine(coll.get(key), value, key));
|
||
|
|
} else {
|
||
|
|
coll.set(key, value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return coll;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
__name(Collection, "Collection");
|
||
|
|
|
||
|
|
// src/index.ts
|
||
|
|
var version = "1.5.1";
|
||
|
|
export {
|
||
|
|
Collection,
|
||
|
|
version
|
||
|
|
};
|
||
|
|
//# sourceMappingURL=index.mjs.map
|