Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.interrupt

Creates an Fx that immediately interrupts.

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

Follow one execution

Deliver an interruption Cause rather than a successful completion.

Fx timelineinterrupt(1)interrupt
Operatorinterrupt(1)
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.

Construction is inert. Each run forwards one interruption cause carrying id to the sink, emits no values, and acquires no resources.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.interrupt 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 interrupt: (fiberId?: number | undefined) => import("../Fx.js").Fx<never, never, never>;

Why

A known Effect interruption cause can be represented as an Fx branch without disguising it as a typed failure or defect.

Ownership and lifetime

Construction is inert. Each run forwards one interruption cause carrying id to the sink, emits no values, and acquires no resources.

Examples

import { Effect } from "effect"
import { interrupt, observe } from "@typed/fx/Fx"

const source = interrupt(1)
const program = observe(source, () => Effect.void)

Other public imports

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

Source