array.filter()

Create an Array of elements filtered by a Function.

Signature

filter(predicate: (element: T) => Boolean | Null) => Array<T>

Description

The filter() method calls the predicate Function with each Array element as a parameter. The Array elements are passed as a parameter, sequentially, to predicate. The method creates an Array that consists of the Array elements for which the function calls evaluate to true.

the calling Array isn’t changed.

Parameters

Parameter Type Required Description

predicate

Function

Yes

Function to apply to each element of the calling Array. The predicate parameter must reference a boolean Function that evaluate to true or false when applied to the element parameter, or Null.

predicate parameters:

Parameter Type Required Description

element

Any

Array element to evaluate.

Return value

Type Description

Array

Array consisting of the elements that evaluate to true when the predicate function is applied to the calling array. If no predicate calls evaluate to true, the method returns an empty Array.

Examples

[1, 2, 3, 4, 5].filter((x) => {x == 1 || x == 4})
[
  1,
  4
]

See also

array.where()

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!