HH\ImmMap::filter

Returns an ImmMap containing the values of the current ImmMap that meet a supplied condition.

Description

public function filter(
  callable $callback,
): ImmMap<Tk,Tv>

Returns an ImmMap containing the values of the current ImmMap that meet a supplied condition.

Only values that meet a certain criteria are affected by a call to filter(), while all values are affected by a call to map().

The keys associated with the current ImmMap remain unchanged in the returned Map.

Parameters

  • callable $callback - The callback containing the condition to apply to the current ImmMap values.

Return Values

Examples

See Map::filter for usage examples.