Class Collection

Object
   |
   +--Collection

Direct Known Subclasses:

Array, Hash

class Collection

Defined in structures.js

accept

Array accept(<Function> filter, <Object> scope)

Applies a filter function on all the elements of the collection. Returns back an array of elements that satisfy the filter

Parameters:
filter - Filter function
scope - Scope object

Returns:
Array of members that satisfy the filter

contains

Boolean contains(<Object> obj)

Verify if the collection contains a given object

Parameters:
obj - Object to be searched

every

Boolean every(<Function> filter, <Object> scope)

Applies a filter function on all elements of the collection. Returns true if all member satisfy the filter.

Parameters:
filter - Filter function
scope - Scope object

extract

Array extract(<String> property)

Reads the value of the property 'property' in each element of the collection, and return the results in an Array object

Parameters:
property - Property name

grep

Array grep(<RegExp> pattern)

Collect the collection members that satisfy a given regexp pattern. The return value of this method is an array. Works better on string collections

Parameters:
pattern - Regexp pattern

inject

Object inject(<Object> memo, <Function> iterator, <Object> scope)

Injects the results of an iterator over all collection elements. The iterator function is called with the passed memo as first parameter. Every iteration must return the new value of 'memo'

Parameters:
memo - Object to inject collection members
iterator - Iterator function
scope - Scope object

invoke

void invoke(<String> method)

Call a given method of the collection items, using the provided arguments. This method considers that all the collection items are objects

Parameters:
method - Method name

map

Array map(<Function> iterator, <Object> scope)

Returns a new copy of the collection applying a given iterator to every element

Parameters:
iterator - Iterator function
scope - Scope object

reject

Array reject(<Function> filter, <Object> scope)

Applies a filter function on the collection's elements, returning back an array of elements that DON'T satisfy the filter

Parameters:
filter - Filter function
scope - Scope object

Returns:
Array of members that don't satisfy the filter

some

Boolean some(<Function> filter, <Object> scope)

Applies a filter function on all elements of the collection. Returns true if at least one member satisfy the filter.

Parameters:
filter - Filter function
scope - Scope object

valid

Array valid(<Function> filter, <Object> scope)

Applies a filter function on the collection's element, pushing the not null return values to a resulting array

Parameters:
filter - Filter function
scope - Scope object

walk

void walk(<Function> iterator)

Applies an iterator function to all the members of the collection. The iterator receives the member and the current iteration index. In order to emulate the break functionality, you must throw an exception named $break.

Parameters:
iterator - Iterator function