Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 03:23:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

types: add ReadonlyCollection (#7245)

Browse Source 
Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>
This commit is contained in:
Suneet Tipirneni
2022-01-11 06:30:16 -05:00
committed by GitHub
parent 16938da355
commit db25f529b2
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/collection/src/index.ts
View File

@@ -9,6 +9,12 @@ export interface CollectionConstructor {
readonly [Symbol.species]: CollectionConstructor; readonly [Symbol.species]: CollectionConstructor;
} }
/**
* Represents an immutable version of a collection
*/
export type ReadonlyCollection<K, V> = ReadonlyMap<K, V> &
Omit<Collection<K, V>, 'forEach' | 'ensure' | 'reverse' | 'sweep' | 'sort' | 'get' | 'set' | 'delete'>;
/** /**
* Separate interface for the constructor so that emitted js does not have a constructor that overwrites itself * Separate interface for the constructor so that emitted js does not have a constructor that overwrites itself
* *
@@ -562,7 +568,7 @@ export class Collection<K, V> extends Map<K, V> {
* @example * @example
* const newColl = someColl.clone(); * const newColl = someColl.clone();
*/ */
public clone() { public clone(): Collection<K, V> {
return new this.constructor[Symbol.species](this); return new this.constructor[Symbol.species](this);
} }
@@ -574,7 +580,7 @@ export class Collection<K, V> extends Map<K, V> {
* @example * @example
* const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl); * const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);
*/ */
public concat(...collections: Collection<K, V>[]) { public concat(...collections: ReadonlyCollection<K, V>[]) {
const newColl = this.clone(); const newColl = this.clone();
for (const coll of collections) { for (const coll of collections) {
for (const [key, val] of coll) newColl.set(key, val); for (const [key, val] of coll) newColl.set(key, val);
@@ -591,7 +597,7 @@ export class Collection<K, V> extends Map<K, V> {
* *
* @returns Whether the collections have identical contents * @returns Whether the collections have identical contents
*/ */
public equals(collection: Collection<K, V>) { public equals(collection: ReadonlyCollection<K, V>) {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (!collection) return false; // runtime check if (!collection) return false; // runtime check
if (this === collection) return true; if (this === collection) return true;
@@ -634,7 +640,7 @@ export class Collection<K, V> extends Map<K, V> {
* *
* @param other The other Collection to filter against * @param other The other Collection to filter against
*/ */
public intersect<T>(other: Collection<K, T>): Collection<K, T> { public intersect<T>(other: ReadonlyCollection<K, T>): Collection<K, T> {
const coll = new this.constructor[Symbol.species]<K, T>(); const coll = new this.constructor[Symbol.species]<K, T>();
for (const [k, v] of other) { for (const [k, v] of other) {
if (this.has(k) && Object.is(v, this.get(k))) { if (this.has(k) && Object.is(v, this.get(k))) {
@@ -649,7 +655,7 @@ export class Collection<K, V> extends Map<K, V> {
* *
* @param other The other Collection to filter against * @param other The other Collection to filter against
*/ */
public difference<T>(other: Collection<K, T>): Collection<K, V | T> { public difference<T>(other: ReadonlyCollection<K, T>): Collection<K, V | T> {
const coll = new this.constructor[Symbol.species]<K, V | T>(); const coll = new this.constructor[Symbol.species]<K, V | T>();
for (const [k, v] of other) { for (const [k, v] of other) {
if (!this.has(k)) coll.set(k, v); if (!this.has(k)) coll.set(k, v);