Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx/Fx

exit

Materializes every success and the terminal failure as infallible Exit values.

Package version
2.0.0-beta.7
Category
Errors and recovery
Since
1.0.0

Follow one execution

Materializes every success and the terminal failure as infallible Exit values.

Fx timelineexit materializes values and the terminal Cause without failingexit
Operatorexit
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.

Each source value becomes Exit.succeed in arrival order. A source failure, including a defect or interrupt, becomes one Exit.failCause, after which the returned Fx completes with error type never. It acquires no resource beyond the single source subscription.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Signatures

export declare const exit: <A, E, R>(fx: Fx<A, E, R>) => Fx<Exit.Exit<A, E>, never, R>;

Why

Turning both channels into data lets downstream Fx composition inspect complete Effect causes without terminating the pipeline.

Ownership and lifetime

Each source value becomes Exit.succeed in arrival order. A source failure, including a defect or interrupt, becomes one Exit.failCause, after which the returned Fx completes with error type never. It acquires no resource beyond the single source subscription.

Examples

import { exit } from "@typed/fx/Fx"
import { fail } from "@typed/fx/Fx"

const outcomes = exit(fail("offline"))

Other public imports

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

Source