HH\Set::skip

Returns a Set containing the values after the n-th element of the current Set.

Description

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

Returns a Set containing the values after the n-th element of the current Set.

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

  • int $n - The last element to be skipped; the $n+1 element will be the first one in the returned Set.

Return Values

  • Set<Tv> - A Set that is a proper subset of the current Set containing values after the specified n-th element.

Examples

<?hh

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

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

// Create a new Set after skipping the first two elements ('red' and 'green')
$skip2 = $s->skip(2);

var_dump($skip2);
Output
object(HH\Set)#2 (2) {
  string(4) "blue"
  string(6) "yellow"
}