effect-io-ai

Package: effect
Module: Array

Array.get

Reads an element at the given index safely, returning Option.some or Option.none if the index is out of bounds.

When to use

Use when you need to read an array element by index and handle an out-of-bounds index as Option.none.

Details

The index is floored to an integer. This never throws.

Example (Accessing indexes safely)

import { Array } from "effect"

console.log(Array.get([1, 2, 3], 1)) // Some(2)
console.log(Array.get([1, 2, 3], 10)) // None

See

• getUnsafe for indexed access that throws when the index is out of bounds
• head for reading the first element as an Option
• last for reading the last element as an Option

Signature

declare const get: { (index: number): <A>(self: ReadonlyArray<A>) => Option.Option<A>; <A>(self: ReadonlyArray<A>, index: number): Option.Option<A>; }

Source

Since v2.0.0