effect-io-ai

Package: effect
Module: Array

Array.removeOption

Delete the element at the specified index, creating a new Array, or return None if the index is out of bounds.

Example

import * as assert from "node:assert"
import { Array, Option } from "effect"

const numbers = [1, 2, 3, 4]
const result = Array.removeOption(numbers, 2)
assert.deepStrictEqual(result, Option.some([1, 2, 4]))

const outOfBoundsResult = Array.removeOption(numbers, 5)
assert.deepStrictEqual(outOfBoundsResult, Option.none())

Signature

declare const removeOption: { (i: number): <A>(self: Iterable<A>) => Option.Option<Array<A>>; <A>(self: Iterable<A>, i: number): Option.Option<Array<A>>; }

Source

Since v3.16.0