Take

:::info[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 an ImmVector containing the first $n values of the current ImmVector

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

The returned ImmVector will always be a subset (but not necessarily a proper subset) of the current ImmVector. If $n is greater than the length of the current ImmVector, the returned ImmVector will contain all elements of the current ImmVector.

$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 ImmVector.

Returns

• ImmVector<Tv> - An ImmVector that is a subset of the current ImmVector up to $n elements.

Examples

See Vector::take for usage examples.