Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/fx

Fx.tuple

Combines multiple Fx streams into a single Fx that emits a tuple of the latest values from each stream. The resulting Fx waits for all input streams to emit at least once before emitting the first tuple. Afterwards, it emits a new tuple whenever any input stream emits a new value.

Package version
2.0.0-beta.7
Category
Combining sources
Since
1.0.0
Member of
Fx

Follow one execution

Retain one latest value per input; emit a tuple after all have initialized, then on any change.

Fx timelinetuple(query, filter)tuple
Operatortuple(query, filter)
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.

All inputs run concurrently as children of the consumer and one latest value per input is retained for that run. Failure/interruption stops the group; normal completion waits for every input.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.tuple 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 function tuple<FX extends ReadonlyArray<Fx<any, any, any>>>(...fxs: FX): Fx<{
    readonly [K in keyof FX]: Fx.Success<FX[K]>;
}, Fx.Error<FX[number]>, Fx.Services<FX[number]>>;

Why

tuple combines independent push sources by latest value while retaining their positional types. It emits nothing until every source has produced once, then emits a snapshot after any update.

Ownership and lifetime

All inputs run concurrently as children of the consumer and one latest value per input is retained for that run. Failure/interruption stops the group; normal completion waits for every input.

Examples

import { Fx } from "@typed/fx"
const point = Fx.tuple(Fx.succeed(10), Fx.succeed(20))

Other public imports

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

Source