Class: ACollector

Extends

• module:ink/collector~CollectorBase

Members

difference

Creates an array of array elements not present in the other arrays using strict equality for comparisons, i.e. ===.

Source:

• collector.js, line 384

head

Gets the first n values of the array

Source:

• collector.js, line 402

length :integer

Get the size of the collection

Type:

• integer

Inherited From:

• module:ink/collector~CollectorBase#length

Source:

• collector.js, line 48

tail

This method gets all but the first values of array

Source:

• collector.js, line 393

Methods

add(item)

Adds to the top of the collection

Parameters:

Name	Type	Description
item	*	The item to add to the collection. Only one item at a time can be added

Source:

• collector.js, line 345

all(qu) → {boolean}

Returns true if all items match the query. Aliases as every

Parameters:

Name	Type	Description
qu	object	The query to execute

Inherited From:

• module:ink/collector~CollectorBase#all

Source:

• collector.js, line 521

Returns:

Type

boolean

any(qu) → {boolean}

Returns true if any of the items match the query. Aliases as all

Parameters:

Name	Type	Description
qu	object	The query to execute

Inherited From:

• module:ink/collector~CollectorBase#any

Source:

• collector.js, line 524

Returns:

Type

boolean

append(item)

Add to the bottom of the list

Parameters:

Name	Type	Description
item	*	The item to add to the collection. Only one item at a time can be added

Source:

• collector.js, line 355

at(args)

Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes

Parameters:

Name	Type	Description
args	indexes	The indexes to use

Source:

• collector.js, line 411

compact()

Modifies the collection with all falsey values of array removed. The values false, null, 0, "", undefined and NaN are all falsey.

Source:

• collector.js, line 374

countBy(query, iterator, thisobj) → {object}

Creates an object composed of keys returned from running each element of the collection through the given callback. The corresponding value of each key is the number of times the key was returned by the callback.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate. If you pass in a query, only the items that match the query are iterated over.
iterator	function
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#countBy

Source:

• collector.js, line 158

Returns:

Type

object

each(query, iterator, thisobj)

Iterate over each item in the collection, or a subset that matches a query. This supports two signatures: .each(query, function) and .each(function). If you pass in a query, only the items that match the query are iterated over.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate
iterator	function		Function to execute against each item in the collection
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#each

Source:

• collector.js, line 72

every(qu) → {boolean}

Returns true if all items match the query. Aliases as all

Parameters:

Name	Type	Description
qu	object	The query to execute

Inherited From:

• module:ink/collector~CollectorBase#every

Source:

• collector.js, line 489

Returns:

Type

boolean

find(qu) → {array}

Find all records that match a query

Parameters:

Name	Type	Description
qu	object	The query to execute.

Inherited From:

• module:ink/collector~CollectorBase#find

Source:

• collector.js, line 562

Returns:

The results

Type

array

findKeys(qu) → {array}

Find all records that match a query and returns the keys for those items. This is similar to module:ink/probe.find but instead of returning records, returns the keys. If obj is an object it will return the hash key. If 'obj' is an array, it will return the index

Parameters:

Name	Type	Description
qu	object	The query to execute.

Inherited From:

• module:ink/collector~CollectorBase#findKeys

Source:

• collector.js, line 559

Returns:

Type

array

findOne(qu) → {object}

Returns the first record that matches the query. Aliased as seek.

Parameters:

Name	Type	Description
qu	object	The query to execute.

Inherited From:

• module:ink/collector~CollectorBase#findOne

Source:

• collector.js, line 556

Returns:

Type

object

findOneKey(qu) → {object}

Returns the first record that matches the query and returns its key or index depending on whether obj is an object or array respectively. Aliased as seekKey.

Parameters:

Name	Type	Description
qu	object	The query to execute.

Inherited From:

• module:ink/collector~CollectorBase#findOneKey

Source:

• collector.js, line 553

Returns:

Type

object

flatten(query, iterator,, thisobj) → {number}

Flattens a nested array (the nesting can be to any depth). If isShallow is truthy, array will only be flattened a single level. If callback is passed, each element of array is passed through a callback before flattening.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate . If you pass in a query, only the items that match the query are iterated over.
iterator,	function
thisobj	object	<optional>	The value of this

Source:

• collector.js, line 429

Returns:

Type

number

groupBy(query, iterator, thisobj) → {object}

Creates an object composed of keys returned from running each element of the collection through the callback. The corresponding value of each key is an array of elements passed to callback that returned the key. The callback is invoked with three arguments: (value, index|key, collection).

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate . If you pass in a query, only the items that match the query are iterated over.
iterator	function
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#groupBy

Source:

• collector.js, line 180

Returns:

Type

object

index(key) → {*}

Gets an items by its index

Parameters:

Name	Type	Description
key	number	The index to get

Source:

• collector.js, line 446

Returns:

Type

*

map(query, iterator, thisobj) → {array}

Maps the contents to an array by iterating over it and transforming it. You supply the iterator. Supports two signatures: .map(query, function) and .map(function). If you pass in a query, only the items that match the query are iterated over.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate
iterator	function		The function that will be executed in each item in the collection
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#map

Source:

• collector.js, line 113

Returns:

Type

array

max(query, iterator, thisobj) → {number}

Retrieves the maximum value of an array. If callback is passed, it will be executed for each value in the array to generate the criterion by which the value is ranked.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate . If you pass in a query, only the items that match the query are iterated over.
iterator	function
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#max

Source:

• collector.js, line 253

Returns:

Type

number

min(query, iterator, thisobj) → {number}

Retrieves the minimum value of an array. If callback is passed, it will be executed for each value in the array to generate the criterion by which the value is ranked.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate . If you pass in a query, only the items that match the query are iterated over.
iterator	function
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#min

Source:

• collector.js, line 274

Returns:

Type

number

pluck(query, property) → {*}

Reduce the collection to a single value. Supports two signatures: .pluck(query, function) and .pluck(function)

Parameters:

Name	Type	Argument	Description
query	object	<optional>	The query to evaluate. If you pass in a query, only the items that match the query are iterated over.
property	string		The property that will be 'plucked' from the contents of the collection

Inherited From:

• module:ink/collector~CollectorBase#pluck

Source:

• collector.js, line 200

Returns:

Type

*

push(item)

Add an item to the top of the list. This is identical to add, but is provided for stack semantics

Parameters:

Name	Type	Description
item	*	The item to add to the collection. Only one item at a time can be added

Source:

• collector.js, line 365

reduce(query, iterator, accumulator, thisobj) → {*}

Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not passed, the first element of the collection will be used as the initial accumulator value. are iterated over.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	A query to evaluate
iterator	function		The function that will be executed in each item in the collection
accumulator	*	<optional>	Initial value of the accumulator.
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#reduce

Source:

• collector.js, line 136

Returns:

Type

*

remove(qu) → {object|array}

Remove all items in the object/array that match the query

Parameters:

Name	Type	Description
qu	object	The query to execute. See module:ink/probe.queryOperators for the operators you can use.

Inherited From:

• module:ink/collector~CollectorBase#remove

Source:

• collector.js, line 527

Returns:

The array or object as appropriate without the records.

Type

object | array

shuffle() → {array}

Creates an array of shuffled array values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.

Inherited From:

• module:ink/collector~CollectorBase#shuffle

Source:

• collector.js, line 220

Returns:

Type

array

some(qu) → {boolean}

Returns true if any of the items match the query. Aliases as any

Parameters:

Name	Type	Description
qu	object	The query to execute

Inherited From:

• module:ink/collector~CollectorBase#some

Source:

• collector.js, line 492

Returns:

Type

boolean

sortBy(query, iterator, thisobj) → {array}

Returns a sorted copy of the collection.

Parameters:

Name	Type	Argument	Description
query	object	<optional>	The query to evaluate. If you pass in a query, only the items that match the query are iterated over.
iterator	function
thisobj	object	<optional>	The value of this

Inherited From:

• module:ink/collector~CollectorBase#sortBy

Source:

• collector.js, line 232

Returns:

Type

array

toArray() → {array}

Returns the collection as an array. If it is already an array, it just returns that.

Inherited From:

• module:ink/collector~CollectorBase#toArray

Source:

• collector.js, line 88

Returns:

Type

array

toJSON() → {object}

Supports conversion to a JSON string or for passing over the wire

Inherited From:

• module:ink/collector~CollectorBase#toJSON

Source:

• collector.js, line 98

Returns:

Type

object

unique(qu) → {array}

Returns the set of unique records that match a query

Parameters:

Name	Type	Description
qu	object	The query to execute.

Inherited From:

• module:ink/collector~CollectorBase#unique

Source:

• collector.js, line 495

Returns:

Type

array

update(qu, setDocument)

Updates all records in obj that match the query. See module:ink/probe.updateOperators for the operators that are supported.

Parameters:

Name	Type	Description
qu	object	The query which will be used to identify the records to updated
setDocument	object	The update operator. See module:ink/probe.updateOperators

Inherited From:

• module:ink/collector~CollectorBase#update

Source:

• collector.js, line 598