ContextQMD
Back to Hhvm

SkipWhile

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

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

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

The returned ImmMap will always be a proper subset of the current ImmMap.

Parameters

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

Returns

  • ImmMap<Tk,Tv> - An ImmMap that is a proper subset of the current ImmMap starting after the callback returns true.

Examples

See Map::skipWhile for usage examples.

<!-- HHAPIDOC -->