Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.fromIterable

Creates an Fx from an Iterable. Emits each value from the iterable in order and then completes.

Package version
2.0.0-beta.13
Category
Value sources
Since
1.0.0
Member of
Fx

Follow one execution

Visit iterable elements in order, awaiting each delivery before the next.

Fx timelinefromIterable([a, b, c])fromIterable
OperatorfromIterable([a, b, c])
Read this diagram

Follow each lane from left to right. Events stacked vertically share a tick; the green cursor marks the current time across every lane.

  • A value
    The text inside the pill is the emitted value.
  • Work starts
    The raised chevron starts an inner run (^ in the source).
  • The run returns
    The vertical bar ends this lane’s run.
  • A cause is delivered
    The exclamation mark belongs to this lane.
  • Work is interrupted
    The cross marks cancellation of this run.
  • Current time
    The line and diamond move together across all lanes.
  • Happening now
    A highlighted event is at the current tick.
  • Still ahead
    Muted, dashed values have not happened yet.
  • Time continues
    The lane’s arrow is not a return marker. An empty stretch can be quiet work that is still running.

Illustrated ticks start at 0. At 1×, one illustrated tick takes one second; captions specify real durations when timing matters. A cause or interruption belongs to its lane, and other work may continue. Scroll horizontally to inspect the rest of a long timeline.

Construction stores the iterable but does not iterate it. Each run obtains a fresh iterator, offers values sequentially to the sink, and completes after iteration. Interruption stops further iteration. No child fiber or buffer is created.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

import { Fx } from "@typed/fx";

Access Fx.fromIterable through the imported Fx export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare const fromIterable: <A>(iterable: Iterable<A>) => Fx<A>;

Why

Finite synchronous collections can participate in push composition without changing their iteration order or introducing a separate collection protocol.

Ownership and lifetime

Construction stores the iterable but does not iterate it. Each run obtains a fresh iterator, offers values sequentially to the sink, and completes after iteration. Interruption stops further iteration. No child fiber or buffer is created.

Examples

import { Effect } from "effect"
import { collectAll, fromIterable } from "@typed/fx/Fx"

const program = collectAll(fromIterable(new Set([1, 2, 3]))).pipe(
  Effect.map((values) => values.join(","))
)

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source