array.at()

Get the Array element at a provided index.

Signature

at(index: Number) => A

Description

Gets the Array element located at a provided index. The method is equivalent to using [] indexing, such that array.at(0) returns the same element as array[0].

Parameters

Parameter Type Required Description

index

Number

true

Location of the Array element to return. Must be an Int.

Arrays have zero-based indexes. Valid index values are zero to one less than the Array length. Invalid index values result in an error.

Return value

Type Description

Generic

Array element located at the provided index.

Examples

Get the element at index location four:

[1, 2, 3, 4, 5].at(4)
5
\