HH\Set::take

Returns a Set containing the first n values of the current Set

Description

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

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

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

Parameters

  • $n - The last element that will be included in the Set.

Return Values

  • Set<Tv> - A Set that is a proper subset of the current Set up to n elements.

Examples

<?hh

namespace Hack\UserDocumentation\API\Examples\Set\Take;

$s = Set {'red', 'green', 'blue', 'yellow'};

// Take the first two elements
$take2 = $s->take(2);

var_dump($take2);
Output
object(HH\Set)#2 (2) {
  string(3) "red"
  string(5) "green"
}