Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx/Fx

collectUpToFork

Forks the collection of up to n values from an Fx.

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

Follow one execution

Return a Fiber for bounded collection; the second value ends its producer and resolves its joined result.

Fx timelinecollectUpToFork(source, 2)collectUpToFork
OperatorcollectUpToFork(source, 2)
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 Effect starts a supervised child immediately. It retains at most upTo values, stops upstream at the bound, and is interrupted when its parent terminates. Source failures are reported by the child fiber.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Signatures

export declare const collectUpToFork: <A, E = never, R = never>(fx: Fx<A, E, R>, upTo: number) => Effect.Effect<Fiber.Fiber<ReadonlyArray<A>, E>, never, R>;

Why

A bounded collection can run concurrently while the caller keeps control through the returned fiber.

Ownership and lifetime

Running the Effect starts a supervised child immediately. It retains at most upTo values, stops upstream at the bound, and is interrupted when its parent terminates. Source failures are reported by the child fiber.

Examples

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

const program = Effect.gen(function* () {
  const fiber = yield* collectUpToFork(periodic("10 millis"), 2)
  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