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

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

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

Returns

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

Examples

See Vector::zip for usage examples.