HH\Pair::take

Returns an ImmVector containing the first n values of the current Pair

Description

public function take(
  int $n,
): ImmVector<mixed>

n is 1-based. So the first element is 1, the second 2. There is no element 3 in a Pair, but if you specify an element greater than 2, it will just return all elements in the Pair.

Parameters

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

Return Values

Examples

<?hh

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

$p = Pair {'foo', -1.5};

// Taking 0 returns an empty ImmVector
var_dump($p->take(0));

// Taking 1 returns an ImmVector of the first value
var_dump($p->take(1));

// Taking 2 (or more) returns an ImmVector containing both values
var_dump($p->take(2));
Output
object(HH\ImmVector)#2 (0) {
}
object(HH\ImmVector)#2 (1) {
  [0]=>
  string(3) "foo"
}
object(HH\ImmVector)#2 (2) {
  [0]=>
  string(3) "foo"
  [1]=>
  float(-1.5)
}