array.take()

This method operates on an array. You typically fetch documents from a collection as a set, not an Array. For the equivalent Set method, see set instance methods.

For differences between Sets and Arrays, see Sets vs. Arrays.

Get the first N elements of an Array.

Signature

take(limit: Number) => Array<A>

Description

Takes the first N elements from the calling Array and returns them as a new Array. If there are fewer values than N elements in the Array, all elements are returned.

The calling Array isn’t changed.

Parameters

Parameter Type Required Description

limit

Number

Yes

Number of elements to return from the start of the Array.

Return value

Type Description

Array<Generic>

Array containing the requested elements.

Examples

[1, 2, 3, 4, 5].take(2)
[
  1,
  2
]

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!