Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.fromFailures

Creates an Fx from a collection of failures (errors).

Package version
2.0.0-beta.7
Category
Failure sources
Since
1.0.0
Member of
Fx

Follow one execution

Consume the iterable at construction and combine its typed failures into one Cause, delivered once per run.

Fx timelinefromFailures([name, email])fromFailures
OperatorfromFailures([name, email])
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.

The iterable is consumed eagerly when fromFailures is called. Running the result forwards the combined cause once, emits no values, and acquires no resources. An empty iterable produces the empty Cause.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.fromFailures 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 fromFailures: <E>(failures: Iterable<E>) => import("../Fx.js").Fx<never, E, never>;

Why

Validation and batch operations can preserve every independent typed failure in a single Effect Cause rather than choosing one error or emitting partial values. Equal reasons are de-duplicated by Cause.combine.

Ownership and lifetime

The iterable is consumed eagerly when fromFailures is called. Running the result forwards the combined cause once, emits no values, and acquires no resources. An empty iterable produces the empty Cause.

Examples

import { Effect } from "effect"
import { fromFailures, observe } from "@typed/fx/Fx"

const failures = fromFailures(["name", "email"])
const program = observe(failures, () => Effect.void).pipe(
  Effect.catch((error) => Effect.succeed(error))
)

Other public imports

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

Source