discord.js/src/util/Collection.js

/**
 * A utility class to help make it easier to access the data stores
 * @extends {Map}
 */
class Collection extends Map {
  /**
   * Returns an ordered array of the values of this collection.
   * @returns {array}
   * @example
   * // identical to:
   * Array.from(collection.values());
   */
  array() {
    return Array.from(this.values());
  }

  /**
   * Returns the first item in this collection.
   * @returns {*}
   * @example
   * // identical to:
   * Array.from(collection.values())[0];
   */
  first() {
    return this.values().next().value;
  }

  /**
   * Returns the last item in this collection. This is a relatively slow operation,
   * since an array copy of the values must be made to find the last element.
   * @returns {*}
   */
  last() {
    const arr = this.array();
    return arr[arr.length - 1];
  }

  /**
   * Returns a random item from this collection. This is a relatively slow operation,
   * since an array copy of the values must be made to find a random element.
   * @returns {*}
   */
  random() {
    const arr = this.array();
    return arr[Math.floor(Math.random() * arr.length)];
  }

  /**
   * If the items in this collection have a delete method (e.g. messages), invoke
   * the delete method. Returns an array of promises
   * @returns {Promise[]}
   */
  deleteAll() {
    const returns = [];
    for (const item of this.values()) {
      if (item.delete) returns.push(item.delete());
    }
    return returns;
  }

  /**
   * Returns an array of items where `item[key] === value` of the collection
   * @param {string} key The key to filter by
   * @param {*} value The expected value
   * @returns {array}
   * @example
   * collection.getAll('username', 'Bob');
   */
  findAll(key, value) {
    if (typeof key !== 'string') throw new TypeError('key must be a string');
    if (typeof value === 'undefined') throw new Error('value must be specified');
    const results = [];
    for (const item of this.values()) {
      if (item[key] === value) results.push(item);
    }
    return results;
  }

  /**
   * Returns a single item where `item[key] === value`
   * @param {string} key The key to filter by
   * @param {*} value The expected value
   * @returns {*}
   * @example
   * collection.get('id', '123123...');
   */
  find(key, value) {
    if (typeof key !== 'string') throw new TypeError('key must be a string');
    if (typeof value === 'undefined') throw new Error('value must be specified');
    for (const item of this.values()) {
      if (item[key] === value) return item;
    }
    return null;
  }

  /**
   * Returns true if the collection has an item where `item[key] === value`
   * @param {string} key The key to filter by
   * @param {*} value The expected value
   * @returns {boolean}
   * @example
   * if (collection.exists('id', '123123...')) {
   *  console.log('user here!');
   * }
   */
  exists(key, value) {
    return Boolean(this.find(key, value));
  }

  /**
   * Identical to
   * [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter),
   * but returns a Collection instead of an Array.
   * @param {function} callback Function used to filter (should return a boolean)
   * @param {Object} [thisArg] Value to set as this when filtering
   * @returns {Collection}
   */
  filter(...args) {
    const newArray = this.array().filter(...args);
    const collection = new Collection();
    for (const item of newArray) collection.set(item.id, item);
    return collection;
  }

  /**
   * Functionally identical shortcut to `collection.array().map(...)`.
   * @param {function} callback Function that produces an element of the new Array, taking three arguments
   * @param {*} [thisArg] Optional. Value to use as this when executing callback.
   * @returns {array}
   */
  map(...args) {
    return this.array().map(...args);
  }
}

module.exports = Collection;