Back to Hhvm

SkipWhile

hphp/hack/manual/apis/Classes/HH/Vector/skipWhile.md

latest1.8 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 a Vector containing the values of the current Vector starting after and including the first value that produces false when passed to the specified callback

Hack
public function skipWhile(
  (function(Tv): bool) $fn,
): Vector<Tv>;

That is, skips the continuous prefix of values in the current Vector for which the specified callback returns true.

The returned Vector will always be a subset (but not necessarily a proper subset) of the current Vector.

Parameters

  • (function(Tv): bool) $fn - The callback used to determine the starting element for the returned Vector.

Returns

  • Vector<Tv> - A Vector that is a subset of the current Vector starting with the value for which the callback first returns false.

Examples

This example shows how skipWhile can be used to create a new Vector by skipping elements at the beginning of an existing Vector:

basic-usage.hack
$v = Vector {0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144};

// Skip values until we reach one over 10
$v2 = $v->skipWhile($x ==> $x <= 10);
\var_dump($v2);
<!-- HHAPIDOC -->