first-elements

array →
first-elements(
    count: integer
) → array

Returns up to the requested number of elements from the start of the input enumerable. Returns null when the input is not an enumerable, is a string, or the count is negative.

Parameters

Name	Type	Required	Description
count	integer	Yes	Number of elements to return from the start of the input.

Argument evaluation

• count: Evaluated once in the enclosing context.

Behavior

When count is greater than the number of elements in the input, first-elements returns all available elements in their original order. It does not pad the result to reach the requested count.

Examples

{1, 2, 3} | first-elements(2) → {1, 2}
{1, 2, 3} | first-elements(5) → {1, 2, 3}

Kind: Function
Scope: array/selection
Aliases: first