Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.collectAllFork

Forks the collection of all values from an Fx.

Package version
2.0.0-beta.13
Category
Collecting values
Since
1.0.0
Member of
Fx

Follow one execution

Return a Fiber immediately; joining it later yields the full collected array.

Fx timelinecollectAllFork(source)collectAllFork
OperatorcollectAllFork(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.

Running the returned Effect starts a child fiber immediately. The parent fiber’s scope supervises it, so parent termination interrupts collection. The child retains every value until completion and exposes source failure as its E channel.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.collectAllFork 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 collectAllFork: <A, E = never, R = never>(fx: Fx<A, E, R>) => Effect.Effect<Fiber.Fiber<ReadonlyArray<A>, E>, never, R>;

Why

Collection can proceed concurrently while the caller retains a typed Fiber for awaiting, polling, or interruption.

Ownership and lifetime

Running the returned Effect starts a child fiber immediately. The parent fiber’s scope supervises it, so parent termination interrupts collection. The child retains every value until completion and exposes source failure as its E channel.

Examples

import { Effect, Fiber } from "effect"
import { collectAllFork, fromIterable } from "@typed/fx/Fx"

const program = Effect.gen(function* () {
  const fiber = yield* collectAllFork(fromIterable([1, 2, 3]))
  return yield* Fiber.join(fiber)
})

Other public imports

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

Source