zip

Note

This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information.

Returns an ImmMap where each value is a Pair that combines the value of the current ImmMap and the provided Traversable

public function zip<Tu>(
  Traversable<Tu> $traversable,
): ImmMap<Tk, Pair<Tv, Tu>>;

If the number of values of the current ImmMap are not equal to the number of elements in the Traversable, then only the combined elements up to and including the final element of the one with the least number of elements is included.

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

Parameters

• Traversable<Tu>$traversable - The Traversable to use to combine with the elements of the current ImmMap.

Returns

• ImmMap<Tk,Pair<Tv, Tu>> - The ImmMap that combines the values of the current ImmMap with the provided Traversable.

Examples

See Map::zip for usage examples.