Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.runPromiseExit

Runs an Fx stream to completion and returns a Promise of the Exit.

Package version
2.0.0-beta.13
Category
Running effects
Since
1.0.0
Member of
Fx

Follow one execution

Always resolve the Promise with an Exit, including a failure Exit rather than a rejected Promise.

Fx timelinerunPromiseExit(source)runPromiseExit
OperatorrunPromiseExit(source)
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.

Calling runPromiseExit starts the source immediately on Effect’s default runtime, so all services must already be eliminated. The root fiber owns the source until it completes; RunOptions can supply cancellation. Values are discarded. The Promise always resolves with an Exit, including failure and interruption.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.runPromiseExit 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 runPromiseExit: <A, E>(fx: Fx<A, E>, options?: RunOptions) => Promise<Exit.Exit<void, E>>;

Why

Promise-based hosts can inspect success or the complete typed failure Cause without Promise rejection erasing Effect’s Exit structure.

Ownership and lifetime

Calling runPromiseExit starts the source immediately on Effect’s default runtime, so all services must already be eliminated. The root fiber owns the source until it completes; RunOptions can supply cancellation. Values are discarded. The Promise always resolves with an Exit, including failure and interruption.

Examples

import { Exit } from "effect"
import { fail, runPromiseExit } from "@typed/fx/Fx"

const outcome = runPromiseExit(fail("offline"))
const failed = outcome.then(Exit.isFailure)

Other public imports

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

Source