Back to Hhvm

Skip

hphp/hack/manual/apis/Classes/HH/ImmVector/skip.md

latest1.7 KB
Original Source

:::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 containing the values after the $n-th element of the current ImmVector

Hack
public function skip(
  int $n,
): ImmVector<Tv>;

The returned ImmVector will always be a subset (but not necessarily a proper subset) of the current ImmVector. If $n is greater than or equal to the length of the current ImmVector, the returned ImmVector will contain no elements. If $n is negative, the returned ImmVector will contain all elements of the current ImmVector.

$n is 1-based. So the first element is 1, the second 2, etc.

Parameters

  • int $n - The last element to be skipped; the $n+1 element will be the first one in the returned ImmVector.

Returns

Examples

See Vector::skip for usage examples.

<!-- HHAPIDOC -->