HH\Iterable::take

Returns an Iterable containing the first n values of the current Iterable.

Description

public function take(
  int $n,
): Iterable<Tv>

Returns an Iterable containing the first n values of the current Iterable.

The returned Iterable 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 Iterable.

Return Values

  • Iterable<Tv> - An Iterable that is a proper subset of the currentIterable up ton` elements.