Function at

at<const Ar extends readonly unknown[]>(
array: Ar,
index: ArgArrayIndexWithNegative<Ar>,
): Optional<Ar[number]>
Safely retrieves an element at a given index from an array, returning an Optional.
Type Parameters
- const Ar extends readonly unknown[]
Parameters
- array: Ar
- index: ArgArrayIndexWithNegative<Ar>
Returns Optional<Ar[number]>
Example
```
const letters: readonly string[] = ['a', 'b', 'c'];

const two = Arr.at(letters, 1);
const last = Arr.at(-1)(letters);
const missing = Arr.at(letters, 5);

assert.deepStrictEqual(two, Optional.some('b'));
assert.deepStrictEqual(last, Optional.some('c'));
assert.deepStrictEqual(missing, Optional.none);
```
- Defined in src/array/impl/array-utils-element-access.mts:20

at(index: ArgArrWithNegative): <E>(array: readonly E[]) => Optional<E>

Safely retrieves an element at a given index from an array, returning an Optional.

Parameters

index: ArgArrWithNegative

Returns <E>(array: readonly E[]) => Optional<E>

Example

const letters: readonly string[] = ['a', 'b', 'c'];

const two = Arr.at(letters, 1);
const last = Arr.at(-1)(letters);
const missing = Arr.at(letters, 5);

assert.deepStrictEqual(two, Optional.some('b'));
assert.deepStrictEqual(last, Optional.some('c'));
assert.deepStrictEqual(missing, Optional.none);

Function at

Type Parameters

Parameters

Returns Optional<Ar[number]>

Example

Parameters

Returns <E>(array: readonly E[]) => Optional<E>

Example

Settings