Collection.API

Class: Collection

Collection

new Collection()

A bare minimum set of utilities for working with collections

Source:

• index.js , lineno 15

Methods

each(collection, callback)

Iterate over each element in a collection.

Parameters:

Name	Type	Description
collection	object | array	The collection to iterate over can be either an array or an object
callback	callback(index, element)	is executed for each element in the collection

Source:

• index.js , lineno 25

Tutorials:

• Tutorial: collection.each

filter(collection, callback, empty) → {object|array}

Return a new collection being a filtered subset of elements from a collection

Parameters:

Name	Type	Argument	Default	Description
collection	object | array			The collection to iterate over can be either an array or an object
callback	callback(element)			Predicate callback is executed for each element in the collection and must return true if the element will be included in the filter
empty	Object | Array	<optional>	empty array	You can provide an empty array or object to be populated by the filter procedure. By default the returned collection is an array however you can populate properties on an object by specifying an object as the empty.

Source:

• index.js , lineno 43

Tutorials:

• Tutorial: collection.filter

Returns:

collection

Type

object | array

find(collection, callback) → {*|null}

Find the first item satisfied by predicate callback in the provided collection

Parameters:

Name	Type	Description
collection	object | array	The collection to iterate over can be either an array or an object
callback	callback(element)	Predicate callback is executed for each element in the collection and must return true if the element will be included in the filter

Source:

• index.js , lineno 65

Tutorials:

• Tutorial: collection.find

Returns:

returns the found element or null if no element wa found

Type

* | null

Generated with wicked.