RiverTrail/RiverTrail — Issue #11: Documentation bug: ParallelArray.filter()
Author: strixinteractive
Created: 2011-11-15 15:43:55+00:00
State: open

Documentation for ParallelArray.filter() is incorrect.

The signature for the *elementalFunction* is `function(arg1, arg2, ...)" as the `this` variable passed into the *elementalFunction* is the actual element - not the array object.; as well as the `index` is not being passed into the function.

Please amend as per below:

`function (arg1, arg2, ...)`

`this` The ParallelArray element
`arg1`, `arg2`, ... Same as the optional arguments passed to filter

`Result`
- true (true, 1, or other JavaScript truthy value) if the source element should be placed in filter’s result.
- false (false, 0, undefined, or other JavaScript falsey value) if the source element should not to be placed in filter’s result.