Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.timeout

Completes the stream if it does not produce a value (or complete) within duration of the previous event. Matches Effect Stream.timeout.

The timeout is reset after each emission. An infinite duration is a no-op; a zero duration completes immediately.

Package version
2.0.0-beta.7
Category
Time and rate
Since
1.0.0
Member of
Fx

Follow one execution

Completes the stream if it does not produce a value (or complete) within duration of the previous event. Matches Effect Stream.timeout. The timeout is reset after each emission. An infinite duration is a no-op; a zero duration completes immediately.

Fx timelinetimeout completes normally after two seconds of silence (1s slots)timeout
Operatortimeout(2 seconds)
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.

Subscription starts the source and one scoped timer. Each delivered value forwards immediately and rearms the timer. If the timer wins, it interrupts the source and the result completes; the interrupt caused by that timeout is not forwarded. Source failure before the deadline propagates. Interruption clears both source fiber and timer. Infinite duration returns the source; zero duration never starts it.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.timeout 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 timeout: {
    (duration: Duration.Input): <A, E, R>(self: Fx<A, E, R>) => Fx<A, E, R | Scope.Scope>;
    <A, E, R>(self: Fx<A, E, R>, duration: Duration.Input): Fx<A, E, R | Scope.Scope>;
};

Why

Silence is meaningful in push systems. This operator turns an idle period into normal completion without inventing an error type.

Ownership and lifetime

Subscription starts the source and one scoped timer. Each delivered value forwards immediately and rearms the timer. If the timer wins, it interrupts the source and the result completes; the interrupt caused by that timeout is not forwarded. Source failure before the deadline propagates. Interruption clears both source fiber and timer. Infinite duration returns the source; zero duration never starts it.

Examples

import { timeout } from "@typed/fx/Fx"
import { periodic } from "@typed/fx/Fx"

const bounded = timeout(periodic("1 second"), "250 millis")

Other public imports

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

Source