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

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

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

Returns

• Vector<Pair<Tv,Tu>> - A Vector that combines the values of the current Vector with the provided Traversable.

Examples

This example shows how zip combines the values of the Vector and another Traversable. The resulting Vector $labeled_colors has three elements because $labels doesn't have a fourth element to pair with $v.

$v = Vector {'red', 'green', 'blue', 'yellow'};

$labels = Vector {'My Favorite', 'My 2nd Favorite', 'My 3rd Favorite'};
$labeled_colors = $v->zip($labels);

\var_dump($labeled_colors->count()); // 3

foreach ($labeled_colors as list($color, $label)) {
  echo $label.': '.$color."\n";
}