GenericCollection

An abstract collection that implements many generic methods, reusable by most collections.

Methods

addEach(values|map): Copies values or entries from another collection into this collection, and then returns this.
deleteEach(values|keys, equals?): Deletes every value or every value for each key. Returns the number of successful deletions.
iterate|iterator(): Iterates every value in this collection.
forEach(callback, thisp?): Calls the callback for each entry in the collection.
map(callback, thisp?): Returns an array of the respective return values of a callback for each entry in this collection.
filter(callback, thisp?): Returns an array with each value from this collection that passes the given test.
group(callback, thisp?, equals?): Returns an array of [key, class] entries where every value from the collection is placed into the same equivalence class if they return the same key through the given callback.
some(callback, thisp?): Returns whether any entry in this collection passes a given test.
every(callback, thisp?): Returns whether every entry in this collection passes a given test.
any(): Returns whether any value in the collection is truthy.
all(): Returns whether all values in the collection are truthy.
only(): Returns the only value in this collection, or undefined if there is more than one value, or if there are no values in the collection.
sorted(compare?): Returns a sorted array of the values in this collection.
reversed(): Returns a copy of this collection with the values in reverse order.
join(delimiter?): Returns a string of all the values in the collection delimited by the given string.
sum(zero?): Returns the sum of all values in this collection.
average(): Returns the arithmetic mean of the collection, by computing its sum and the count of values and returning the quotient.
min(): Returns the smallest value in this collection.
max(): Returns the largest value in this collection.
zip(...iterables): Returns an array of the respective values in this collection and in each collection provided as an argument.
enumerate(start?): Returns an array of [index, value] entries for each value in this collection, counting all values from the given index.
concat(...iterables): Returns a new collection of the same type containing all the values of itself and the values of any number of other iterable collections in order.
flatten(): Assuming that this is a collection of collections, returns a new collection that contains all the values of each nested collection in order.
toArray(): Returns an array of each value in this collection.
toObject(): Returns an object with each property name and value corresponding to the entries in this collection.
clone(depth?, memo?): Creates a deep replica of this collection.

Usage

require("collections/shim-object");
var GenericCollection = require("collections/generic-collection");
Object.addEach(MyCollection.prototype, GenericCollection.prototype);

GenericCollection

Source code

Generated from generic-collection.md