Zip

:::info[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 ImmVector where each element is a Pair that combines each element of the current Pair and the provided Traversable

public function zip<Tu>(
  Traversable<Tu> $traversable,
): ImmVector<Pair<mixed, Tu>>;

If the number of elements of the current Pair 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.

Parameters

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

Returns

• ImmVector<Pair<mixed,Tu>> - The ImmVector that combines the values of the current Pair with the provided Traversable.

Examples

$p = Pair {'foo', -1.5};

$labels = Vector {'First Value', 'Second Value'};
$labeled = $p->zip($labels);

foreach ($labeled as list($value, $label)) {
  echo $label.': '.(string)$value."\n";
}