Collection

Collection

An extended map with utility functions

Constructor

new Collection()

Source:

Extends

  • Map

Methods

filter(func) → {Array}

Source:

Filter values by function

Parameters:
Name Type Description
func function

filter function

Returns:

Array of filtered values

Type
Array

find(func) → {*}

Source:

Find values by function

Parameters:
Name Type Description
func function

find function

Returns:

Value that was found

Type
*

forEach(func)

Source:

Executes a function on all values

Parameters:
Name Type Description
func function

forEach function

groupBy(key) → {Object}

Source:

Group values by key

Parameters:
Name Type Description
key String

The matching key

Returns:

Object containing grouped values

Type
Object

map(func) → {Array}

Source:

Map values by function

Parameters:
Name Type Description
func function

map function

Returns:

Array of mapped values

Type
Array

pluck(key) → {Array}

Source:

Pluck values with key by function

Parameters:
Name Type Description
key String

The matching key

Returns:

Array of keyed values

Type
Array

reduce(func) → {Array}

Source:

Reduce values by function

Parameters:
Name Type Description
func function

reduce function

Returns:

Array of reduced values

Type
Array

toArray() → {Array}

Source:

Returns all items in the collection as an array

Returns:

Array of values

Type
Array

unique() → {Array}

Source:

Get unique values

Returns:

unique Array of unique values

Type
Array