Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.fromStream

Adapts an Effect Stream to a push-based Fx.

Package version
2.0.0-beta.7
Category
Stream interop
Since
1.0.0
Member of
Fx

Follow one execution

Read upstream chunks and deliver each element through the Fx sink; the reader belongs to this run.

Fx timelinefromStream(stream)fromStream
OperatorfromStream(stream)
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.

Conversion starts nothing. Each Fx.run starts one Stream run owned by the caller’s fiber and scope. Interruption stops the Stream and its finalizers. Delivery order and concurrency follow Effect Stream’s mapEffect semantics and options.

Source implementation · Learn the surrounding model

Compare all Fx timelines →

Import

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

Access Fx.fromStream 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 fromStream: <A, E, R>(stream: Stream.Stream<A, E, R>, options?: FromStreamOptions) => Fx.Fx<A, E, R>;

Why

Stream producers can participate in Fx composition without wrapping their behavior in a new abstraction. Each Stream element is offered to the sink through Stream.mapEffect; Stream causes are forwarded unchanged to sink.onFailure.

Ownership and lifetime

Conversion starts nothing. Each Fx.run starts one Stream run owned by the caller’s fiber and scope. Interruption stops the Stream and its finalizers. Delivery order and concurrency follow Effect Stream’s mapEffect semantics and options.

Examples

import { Effect, Stream } from "effect"
import { collectAll, fromStream } from "@typed/fx/Fx"

const source = fromStream(Stream.make("a", "b"))
const values = collectAll(source)
const program = Effect.map(values, (items) => items.join(""))

Other public imports

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

Source