Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.takeUntil

Takes elements from an Fx until a predicate returns true. The element that satisfies the predicate is not included in the output.

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

Follow one execution

Takes elements from an Fx until a predicate returns true. The element that satisfies the predicate is not included in the output.

Fx timelinetakeUntil(isComplete)takeUntil
OperatortakeUntil(isComplete)
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.

Matching triggers the sink’s early-exit path, stopping upstream work. No resources are acquired; earlier failures and consumer interruption remain observable.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.takeUntil 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 takeUntil: {
    <A>(predicate: (a: A) => boolean): <E, R>(fx: Fx<A, E, R>) => Fx<A, E, R>;
    <A, E, R>(fx: Fx<A, E, R>, predicate: (a: A) => boolean): Fx<A, E, R>;
};

Why

takeUntil forwards the ordered prefix before the first match, then completes without emitting the matching value.

Ownership and lifetime

Matching triggers the sink’s early-exit path, stopping upstream work. No resources are acquired; earlier failures and consumer interruption remain observable.

Examples

import { Fx } from "@typed/fx"
const beforeThree = Fx.fromIterable([1, 2, 3]).pipe(Fx.takeUntil((n) => n === 3))

Other public imports

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

Source