Skip to main content

take

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 KeyedIterable containing the first n values of the current KeyedIterable

public function take(
  int $n,
): KeyedIterable<Tk, Tv>;

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

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

Parameters​

  • int $n - The last element that will be included in the returned KeyedIterable.

Returns​