Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.unwrapScoped

Unwraps an Effect that produces an Fx into a single Fx, managing the scope of the effect.

The scope of the effect is closed when the Fx completes or is interrupted.

Package version
2.0.0-beta.13
Category
Generator composition
Since
1.0.0
Member of
Fx

Follow one execution

Unwraps an Effect that produces an Fx into a single Fx, managing the scope of the effect. The scope of the effect is closed when the Fx completes or is interrupted.

Fx timelineunwrapScoped keeps setup resources alive through streamingunwrapScoped
OperatorunwrapScoped(setup)
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.

Acquisition and inner failures are forwarded. Non-Scope services from both phases remain required. The opened Scope owns resources acquired by both the Effect and produced Fx; it closes after normal completion, failure, or interruption, running finalizers exactly at the observation boundary.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.unwrapScoped 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 unwrapScoped: <A, E, R, E2, R2>(effect: Effect.Effect<Fx<A, E, R>, E2, R2 | Scope.Scope>) => Fx<A, E | E2, Exclude<R | R2, Scope.Scope>>;

Why

unwrapScoped is the safe boundary for an Effect that acquires resources while choosing an Fx. It discharges the inner Scope requirement instead of leaking acquisition lifetime to every consumer.

Execution and cardinality

Each observation opens one Scope, runs effect once, then forwards every value from the produced Fx in order. The inner never starts if acquisition fails, and the acquisition Effect adds no output value.

Ownership and lifetime

Acquisition and inner failures are forwarded. Non-Scope services from both phases remain required. The opened Scope owns resources acquired by both the Effect and produced Fx; it closes after normal completion, failure, or interruption, running finalizers exactly at the observation boundary.

Examples

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

const scoped = Fx.unwrapScoped(
  Effect.acquireRelease(
    Effect.succeed(Fx.succeed("connected")),
    () => Effect.void
  )
)

Other public imports

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

Source