filter

Methods

(inner) deepFilter(filterer, childPathopt) → {InputFunction}

Source:

Once fully applied, this iterates through nodes in the provided tree, passing them through a filter function. Only nodes which return a truthy value from the filter function will be present in the modified tree. Nodes are processed branch by branch in the order that Immutable maps through the child iterables, outwards from the root node to leaf nodes. Sibling nodes are processed in the order that Immutable iterates through collections.

Parameters:
Name Type Attributes Default Description
filterer Filterer

The function to be called for each node in the tree, the results of which will be used to create the modified tree.

childPath ChildPath <optional>
null

An Array or List of keys indicating where to find each node's children from within each node.

Returns:

A partially applied function which accepts a single tree Iterable, and returns the modified tree Iterable.

Type
InputFunction