effect-io-ai

Package: effect
Module: Optic

Optic.getAll

Returns a function that extracts all elements focused by a Traversal as a plain mutable array.

When to use

Use when you need the focused values as a simple Array<A> for further processing.

Details

• Returns an empty array when the traversal cannot focus.
• Always returns a fresh array (safe to mutate).

Example (Collecting positive numbers)

import { Optic, Schema } from "effect"

type S = { readonly values: ReadonlyArray<number> }

const _pos = Optic.id<S>()
  .key("values")
  .forEach((n) => n.check(Schema.isGreaterThan(0)))

const getPositive = Optic.getAll(_pos)

console.log(getPositive({ values: [3, -1, 5] }))
// Output: [3, 5]

console.log(getPositive({ values: [-1, -2] }))
// Output: []

See

• Traversal — the optic type this operates on

Signature

declare const getAll: <S, A>(traversal: Traversal<S, A>) => (s: S) => Array<A>

Source

Since v4.0.0