Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.runFork

Runs an Fx in a new fiber, using the standard Effect.runFork. This is useful for integrating with the top-level Effect runtime.

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

Follow one execution

Start draining immediately at the runtime boundary and return a Fiber handle.

Fx timelinerunFork(source)runFork
OperatorrunFork(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.

runFork starts immediately on Effect’s default runtime, so it only accepts an Fx with no unsupplied services. The returned root fiber owns the subscription and must be interrupted by the caller when the source should stop. Values are discarded; failures appear on the fiber and RunOptions controls the runtime launch.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

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

Why

Application and foreign-runtime boundaries sometimes need to start an Fx without already being inside an Effect program.

Ownership and lifetime

runFork starts immediately on Effect’s default runtime, so it only accepts an Fx with no unsupplied services. The returned root fiber owns the subscription and must be interrupted by the caller when the source should stop. Values are discarded; failures appear on the fiber and RunOptions controls the runtime launch.

Examples

import { Effect, Fiber } from "effect"
import { periodic, runFork } from "@typed/fx/Fx"

const fiber = runFork(periodic("1 second"))

// `runFork` is already a host-runtime boundary. Execute the returned
// interruption Effect when this host no longer needs the subscription.
await Effect.runPromise(Fiber.interrupt(fiber))

Other public imports

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

Source