Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

Channel

Provides low-level building blocks for streaming data through Effect.

A Channel can read input elements, write output elements, fail with a typed error, and finish with a typed result while managing resources safely. Streams and sinks are built on channels, so most application code uses those higher-level modules instead. This module is useful when implementing stream operators or specialized streaming workflows.

158 exports Since v2.0.0 Source

Accessors

Creates a channel from the specified services.

Signature

declare function contextWith<Env, OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2>(f: (context: Context<Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env | Env2>

Buffering

Since v2.0.0

Buffers individual output elements in a queue with the configured capacity so a faster producer can progress independently of a slower consumer.

When to use

Use when output elements can be decoupled from downstream demand and the configured backpressure or loss strategy is acceptable.

Details

Finite queues use the strategy option. The default "suspend" strategy applies backpressure, while "dropping" and "sliding" can discard output elements when the queue is full. "unbounded" capacity does not use a finite capacity strategy.

Gotchas

Dropping and sliding strategies can lose output elements under backpressure.

See

  • bufferArray for buffering elements from array outputs

Signature

declare const buffer: {
(options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Buffers array output elements in a queue with the configured capacity so a faster producer can progress independently of a slower consumer.

When to use

Use when emitted arrays are batches of elements and it is acceptable for buffering to flatten and rebuild those batches.

Details

Finite queues use the strategy option. The default "suspend" strategy applies backpressure, while "dropping" and "sliding" can discard output elements when the queue is full. "unbounded" capacity does not use a finite capacity strategy.

Gotchas

Input arrays are offered to the queue element-by-element and outputs are rebuilt from the currently available queued elements, so upstream array boundaries are not preserved.

See

  • buffer for buffering output elements without flattening arrays

Signature

declare const bufferArray: {
(options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Combining

Since v4.0.0

Returns a new channel, which is the merge of this channel and the specified channel.

Signature

declare const merge: {
<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(right: Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly haltStrategy?: HaltStrategy;
}): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(left: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | OutErr, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(left: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, right: Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly haltStrategy?: HaltStrategy;
}): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Merging channels

import { Channel, Effect } from "effect"
// Create two channels
const leftChannel = Channel.fromIterable([1, 2, 3])
const rightChannel = Channel.fromIterable(["a", "b", "c"])
// The default "both" strategy waits for both channels to complete
const mergedChannel = Channel.merge(leftChannel, rightChannel)
const values = await Effect.runPromise(Channel.runCollect(mergedChannel))
values.map(String).sort() // => ["1", "2", "3", "a", "b", "c"]
Since v2.0.0

Merges multiple channels with specified concurrency and buffering options.

When to use

Use when channel outputs are themselves channels and multiple inner channels should run with configured concurrency and buffering.

Signature

declare const mergeAll: {
(options: {
readonly bufferSize?: number;
readonly concurrency: Types.Concurrency;
readonly switch?: boolean;
}): <OutElem, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutErr, OutDone, InElem, InErr, InDone, Env>(channels: Channel<Channel<OutElem, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr1 | OutErr, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutErr, OutDone, InElem, InErr, InDone, Env>(channels: Channel<Channel<OutElem, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, OutErr, OutDone, InElem, InErr, InDone, Env>, options: {
readonly bufferSize?: number;
readonly concurrency: Types.Concurrency;
readonly switch?: boolean;
}): Channel<OutElem, OutErr1 | OutErr, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
}

Example Merging nested channels

import { Channel, Data, Effect } from "effect"
class MergeAllError extends Data.TaggedError("MergeAllError")<{
readonly reason: string
}> {}
// Create channels that output other channels
const nestedChannels = Channel.fromIterable([
Channel.fromIterable([1, 2]),
Channel.fromIterable([3, 4]),
Channel.fromIterable([5, 6])
])
// Merge all channels with bounded concurrency
const mergedChannel = Channel.mergeAll({
concurrency: 1,
bufferSize: 16
})(nestedChannels)
await Effect.runPromise(Channel.runCollect(mergedChannel)) // => [1, 2, 3, 4, 5, 6]

Runs an effect concurrently with a channel while emitting only the channel's output elements.

When to use

Use when a side effect should run for the lifetime of a channel and only the channel's output elements should be emitted.

Details

The effect's successful value is ignored. If the effect fails while the channel is running, the returned channel fails with that error.

Signature

declare const mergeEffect: {
<X, E, R>(effect: Effect<X, E, R>): <OutElem, OutDone, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, X, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, effect: Effect<X, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Constants

The default chunk size used by channels for batching operations.

Signature

declare const DefaultChunkSize: number

Example Reading the default chunk size

import { Channel } from "effect"
Channel.DefaultChunkSize // => 4096

Constructors

Acquires a resource, emits the acquired value as a single channel element, and registers release in the channel scope.

Details

The release action runs when the channel scope closes and receives the scope exit. If acquisition fails, no element is emitted and release is not registered.

Signature

declare const acquireRelease: {
<Z>(release: (z: Z, e: Exit<unknown, unknown>) => Effect<unknown>): <E, R>(self: Effect<Z, E, R>) => Channel<Z, E, void, unknown, unknown, unknown, R>;
<Z, E, R>(self: Effect<Z, E, R>, release: (z: Z, e: Exit<unknown, unknown>) => Effect<unknown>): Channel<Z, E, void, unknown, unknown, unknown, R>;
}

Example Managing resources with acquire-release

import { Channel, Effect } from "effect"
const released: Array<string> = []
const channel = Channel.acquireRelease(
Effect.succeed("resource"),
(resource, exit) => Effect.sync(() => released.push(resource))
)
const observed = [await Effect.runPromise(Channel.runCollect(channel)), released] // => [["resource"], ["resource"]]

Acquires a resource, uses it to build a Channel, and guarantees that release runs with the channel's Exit when the channel completes, fails, or is interrupted.

Details

Acquisition is uninterruptible. If acquisition fails, use is not run and release is not registered.

Signature

declare function acquireUseRelease<A, E, R, OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(acquire: Effect<A, E, R>, use: (a: A) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, release: (a: A, exit: Exit<OutDone, OutErr>) => Effect<unknown>): Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>

Example Managing resources with acquire-use-release

import { Channel, Effect } from "effect"
const released: Array<string> = []
const channel = Channel.acquireUseRelease(
Effect.succeed("resource"),
(resource) => Channel.succeed(resource.toUpperCase()),
(resource, exit) => Effect.sync(() => released.push(resource))
)
const observed = [await Effect.runPromise(Channel.runCollect(channel)), released] // => [["RESOURCE"], ["resource"]]
Since v4.0.0

Creates a Channel that interacts with a callback function using a queue.

Signature

declare function callback<A, E = never, R = never>(f: (queue: Queue<A, E | Done<void>>) => Effect<unknown, E, Scope | R>, options?: {
readonly bufferSize?: number;
readonly strategy?: "sliding" | "dropping" | "suspend";
}): Channel<A, E, void, unknown, unknown, unknown, Exclude<R, Scope>>

Example Creating channels from callbacks

import { Channel, Effect, Queue } from "effect"
const channel = Channel.callback<number>((queue) =>
Effect.gen(function*() {
yield* Queue.offer(queue, 1)
yield* Queue.offer(queue, 2)
yield* Queue.offer(queue, 3)
yield* Queue.end(queue)
})
)
await Effect.runPromise(Channel.runCollect(channel)) // => [1, 2, 3]

Creates a Channel that interacts with a callback function using a queue, emitting arrays.

Signature

declare function callbackArray<A, E = never, R = never>(f: (queue: Queue<A, Done<void> | E>) => Effect<unknown, E, Scope | R>, options?: {
readonly bufferSize?: number;
readonly strategy?: "sliding" | "dropping" | "suspend";
}): Channel<readonly [A, A], E, void, unknown, unknown, unknown, Exclude<R, Scope>>

Example Creating array channels from callbacks

import { Channel, Effect, Queue } from "effect"
const channel = Channel.callbackArray<number>(Effect.fn(function*(queue) {
yield* Queue.offer(queue, 1)
yield* Queue.offer(queue, 2)
yield* Queue.end(queue)
}))
await Effect.runPromise(Channel.runCollect(channel)) // => [[1, 2]]
Since v4.0.0

Constructs a channel that fails immediately with the specified defect.

Signature

declare function die(defect: unknown): Channel<never, never, never>

Example Dying with defects

import { Cause, Channel, Effect, Exit } from "effect"
const defect = "Unrecoverable error"
const diedChannel = Channel.die(defect)
Effect.runSync(Effect.exit(Channel.runCollect(diedChannel))) // => Exit.failCause(Cause.die(defect))
Since v4.0.0

The starting channel for Do notation, emitting an empty object.

Signature

declare const Do: Channel<{}>
Since v2.0.0

Creates a new channel that consumes all output from the source channel but emits nothing, preserving only the completion value.

Signature

declare function drain<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>): Channel<never, OutErr, OutDone, InElem, InErr, InDone, Env>

Example Draining channel output

import { Channel, Effect } from "effect"
// Create a channel that outputs values
const sourceChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Drain all output, keeping only the completion
const drainedChannel = Channel.drain(sourceChannel)
Effect.runSync(Channel.runCollect(drainedChannel)) // => []
Since v4.0.0

Represents a Channel that emits no elements.

Signature

declare const empty: Channel<never>

Example Creating empty channels

import { Channel, Effect } from "effect"
// Create an empty channel
const emptyChannel = Channel.empty
// Use empty channel in composition
const combined = Channel.concatWith(emptyChannel, () => Channel.succeed(42))
// Will immediately provide the second channel's output
// Empty channel can be used as a no-op in conditional logic
const conditionalChannel = (shouldEmit: boolean) =>
shouldEmit ? Channel.succeed("data") : Channel.empty
Effect.runSync(Channel.runCollect(conditionalChannel(true))) // => ["data"]
Since v4.0.0

Creates a Channel that immediately ends with the specified value.

Signature

declare function end<A>(value: A): Channel<never, never, A>

Example Ending with a value

import { Channel, Effect } from "effect"
const channel = Channel.end("done")
Effect.runSync(Channel.runCollect(channel)) // => []
Since v4.0.0

Creates a Channel that immediately ends with the lazily evaluated value.

Signature

declare function endSync<A>(evaluate: LazyArg<A>): Channel<never, never, A>
Since v2.0.0

Constructs a channel that fails immediately with the specified error.

Signature

declare function fail<E>(error: E): Channel<never, E, never>

Example Failing with an error

import { Channel, Effect, Exit } from "effect"
const failedChannel = Channel.fail("Something went wrong")
Effect.runSync(Effect.exit(Channel.runCollect(failedChannel))) // => Exit.fail("Something went wrong")

Constructs a channel that fails immediately with the specified Cause.

When to use

Use when the channel failure must preserve a full Cause, such as defects, interruptions, or combined failures.

Signature

declare function failCause<E>(cause: Cause<E>): Channel<never, E, never>

Example Failing with causes

import { Cause, Channel, Effect, Exit } from "effect"
const simpleCause = Cause.fail("Simple error")
const failedChannel = Channel.failCause(simpleCause)
Effect.runSync(Effect.exit(Channel.runCollect(failedChannel))) // => Exit.failCause(simpleCause)

Constructs a channel that fails immediately with the specified lazily evaluated Cause.

Signature

declare function failCauseSync<E>(evaluate: LazyArg<Cause<E>>): Channel<never, E, never>

Example Failing with lazy causes

import { Cause, Channel, Effect, Exit } from "effect"
// Create a channel that fails with a lazily computed cause
let attempts = 0
const failedChannel = Channel.failCauseSync(() => {
attempts += 1
return Cause.fail(`Runtime error after attempt ${attempts}`)
})
const observed = [
Effect.runSync(Effect.exit(Channel.runCollect(failedChannel))),
attempts
] // => [Exit.fail("Runtime error after attempt 1"), 1]
Since v2.0.0

Constructs a channel that fails immediately with the specified lazily evaluated error.

When to use

Use when the error value should be computed each time the channel runs instead of when the channel is constructed.

Signature

declare function failSync<E>(evaluate: LazyArg<E>): Channel<never, E, never>

Example Failing with a lazy error

import { Channel, Effect, Exit } from "effect"
let attempts = 0
const conditionalError = Channel.failSync(() => {
attempts += 1
return `Error after attempt ${attempts}`
})
const observed = [
Effect.runSync(Effect.exit(Channel.runCollect(conditionalError))),
attempts
] // => [Exit.fail("Error after attempt 1"), 1]
Since v2.0.0

Flattens a channel of channels.

Signature

declare function flatten<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(channels: Channel<Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem, OutErr | OutErr1, OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>

Example Flattening nested channels

import { Channel, Data, Effect } from "effect"
class FlattenError extends Data.TaggedError("FlattenError")<{
readonly cause: string
}> {}
// Create a channel that outputs channels
const nestedChannels = Channel.fromIterable([
Channel.fromIterable([1, 2]),
Channel.fromIterable([3, 4]),
Channel.fromIterable([5, 6])
])
// Flatten the nested channels
const flattenedChannel = Channel.flatten(nestedChannels)
Effect.runSync(Channel.runCollect(flattenedChannel)) // => [1, 2, 3, 4, 5, 6]

Creates a Channel that emits all elements from an array.

Signature

declare function fromArray<A>(array: readonly Array<A>): Channel<A>

Example Creating channels from arrays

import { Channel, Effect } from "effect"
const channel = Channel.fromArray([1, 2, 3, 4, 5])
Effect.runSync(Channel.runCollect(channel)) // => [1, 2, 3, 4, 5]

Creates a channel that pulls values from an AsyncIterable.

Details

Each yielded value is emitted as an output element. The iterator's return value becomes the channel's done value. Thrown or rejected iterator errors are converted with onError. If the channel scope closes early and the iterator has a return method, that method is called.

Signature

declare function fromAsyncIterable<A, D, E>(iterable: AsyncIterable<A, D>, onError: (error: unknown) => E): Channel<A, E, D>

Creates a channel from an AsyncIterable, emitting each yielded value as a single-element non-empty array.

Details

The iterator's return value becomes the channel's done value. Thrown or rejected iterator errors are converted with onError. If the channel scope closes early and the iterator has a return method, that method is called.

Signature

declare function fromAsyncIterableArray<A, D, E>(iterable: AsyncIterable<A, D>, onError: (error: unknown) => E): Channel<readonly [A, A], E, D>

Creates a Channel that emits all elements from a chunk.

Signature

declare function fromChunk<A>(chunk: Chunk<A>): Channel<A>

Example Creating channels from chunks

import { Channel, Chunk, Effect } from "effect"
const chunk = Chunk.make(1, 2, 3)
const channel = Channel.fromChunk(chunk)
Effect.runSync(Channel.runCollect(channel)) // => [1, 2, 3]

Uses an effect to write a single value to the channel.

Signature

declare function fromEffect<A, E, R>(effect: Effect<A, E, R>): Channel<A, Exclude<E, Done<any>>, void, unknown, unknown, unknown, R>

Example Creating channels from effects

import { Channel, Effect } from "effect"
const successChannel = Channel.fromEffect(
Effect.succeed("Hello from effect!")
)
Effect.runSync(Channel.runCollect(successChannel)) // => ["Hello from effect!"]

Creates a channel that evaluates an effect and uses its successful value as the channel's done value without emitting any output elements.

Details

If the effect fails, the channel fails with the effect's error.

Signature

declare function fromEffectDone<A, E, R>(effect: Effect<A, E, R>): Channel<never, Exclude<E, Done<any>>, A, unknown, unknown, unknown, R>

Uses an effect and discards its result.

Signature

declare function fromEffectDrain<A, E, R>(effect: Effect<A, E, R>): Channel<never, E, void, unknown, unknown, unknown, R>

Creates a channel from an effect that produces a Take.

Details

A successful Take emits a non-empty array of output elements. A failed Take fails the channel. A done Take completes the channel with its done value.

Signature

declare function fromEffectTake<A, E, Done, E2, R>(effect: Effect<Take<A, E, Done>, E2, R>): Channel<readonly [A, A], E | E2, Done, unknown, unknown, unknown, R>

Creates a Channel that emits all elements from an iterable.

Signature

declare function fromIterable<A, L>(iterable: Iterable<A, L>): Channel<A, never, L>

Example Creating channels from iterables

import { Channel, Effect } from "effect"
const set = new Set([1, 2, 3])
const channel = Channel.fromIterable(set)
Effect.runSync(Channel.runCollect(channel)) // => [1, 2, 3]

Creates a Channel that emits arrays of elements from an iterable.

Details

Finite fractional chunkSize values are rounded down. NaN and non-positive values are treated as 1.

Signature

declare function fromIterableArray<A, L>(iterable: Iterable<A, L>, chunkSize: number): Channel<readonly [A, A], never, L>

Example Batching iterable output

import { Channel, Effect } from "effect"
const numbers = [1, 2, 3, 4, 5]
const channel = Channel.fromIterableArray(numbers, 4)
Effect.runSync(Channel.runCollect(channel)) // => [[1, 2, 3, 4], [5]]

Creates a Channel from an iterator.

Signature

declare function fromIterator<A, L>(iterator: LazyArg<Iterator<A, L, any>>): Channel<A, never, L>

Example Creating channels from iterators

import { Channel, Effect } from "effect"
const numbers = [1, 2, 3, 4, 5]
const channel = Channel.fromIterator(() => numbers[Symbol.iterator]())
Effect.runSync(Channel.runCollect(channel)) // => [1, 2, 3, 4, 5]

Creates a Channel from an iterator that emits arrays of elements.

Details

Finite fractional chunkSize values are rounded down. NaN and non-positive values are treated as 1 so every successful pull emits a non-empty array.

Signature

declare function fromIteratorArray<A, L>(iterator: LazyArg<Iterator<A, L, any>>, chunkSize: number): Channel<readonly [A, A], never, L>

Example Batching iterator output

import { Channel, Effect } from "effect"
// Create a channel from a simple iterator
const numberIterator = (): Iterator<number, string> => {
let count = 0
return {
next: () => {
if (count < 3) {
return { value: count++, done: false }
}
return { value: "finished", done: true }
}
}
}
const channel = Channel.fromIteratorArray(() => numberIterator(), 2)
Effect.runSync(Channel.runCollect(channel)) // => [[0, 1], [2]]

Example Batching generator output

import { Channel, Effect } from "effect"
// Create channel from a generator function
function* fibonacci(): Generator<number, void, unknown> {
let a = 0, b = 1
for (let i = 0; i < 5; i++) {
yield a
;[a, b] = [b, a + b]
}
}
const fibChannel = Channel.fromIteratorArray(() => fibonacci(), 3)
Effect.runSync(Channel.runCollect(fibChannel)) // => [[0, 1, 1], [2, 3]]

Creates a channel from a PubSub that outputs individual values.

Details

This constructor creates a channel that reads from a PubSub by automatically subscribing to it. The channel outputs individual values as they are published to the PubSub, making it ideal for real-time streaming scenarios.

Signature

declare function fromPubSub<A>(pubsub: PubSub<A>): Channel<A>

Example Creating channels from PubSubs

import { Channel, Data, Effect, Option, PubSub } from "effect"
class StreamError extends Data.TaggedError("StreamError")<{
readonly message: string
}> {}
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.unbounded<number>({ replay: 3 })
// Create a channel that reads individual values
const channel = Channel.fromPubSub(pubsub)
// Publish some values
yield* PubSub.publish(pubsub, 1)
yield* PubSub.publish(pubsub, 2)
yield* PubSub.publish(pubsub, 3)
// The channel will output: 1, 2, 3 (individual values)
return channel
})
const result = Effect.scoped(Effect.flatMap(program, Channel.runHead))
await Effect.runPromise(result) // => Option.some(1)

Example Streaming PubSub notifications

import { Channel, Effect, Option, PubSub } from "effect"
const notificationService = Effect.gen(function*() {
const notificationPubSub = yield* PubSub.unbounded<string>({ replay: 1 })
// Create a channel for real-time notifications
const notificationChannel = Channel.fromPubSub(notificationPubSub)
// Transform notifications to add timestamps
const receivedAt = "2024-01-01T00:00:00.000Z"
const timestampedChannel = Channel.map(notificationChannel, (message) => ({
message,
receivedAt,
id: `notification:${message}`
}))
yield* PubSub.publish(notificationPubSub, "ready")
return timestampedChannel
})
const notification = Effect.scoped(Effect.flatMap(notificationService, Channel.runHead))
await Effect.runPromise(notification) // => Option.some({ message: "ready", receivedAt: "2024-01-01T00:00:00.000Z", id: "notification:ready" })

Example Processing PubSub events

import { Channel, Effect, Option, PubSub } from "effect"
interface DomainEvent {
readonly type: string
readonly payload: unknown
readonly timestamp: number
}
const eventProcessor = Effect.gen(function*() {
const eventPubSub = yield* PubSub.unbounded<DomainEvent>({ replay: 1 })
// Create a channel for processing domain events
const eventChannel = Channel.fromPubSub(eventPubSub)
// Filter and transform events
const processedChannel = Channel.map(eventChannel, (event) => {
if (event.type === "user.created") {
return {
...event,
processed: true,
processedAt: event.timestamp + 1
}
}
return event
})
yield* PubSub.publish(eventPubSub, { type: "user.created", payload: {}, timestamp: 1 })
return processedChannel
})
const event = Effect.scoped(Effect.flatMap(eventProcessor, Channel.runHead))
const result = await Effect.runPromise(event) // => Option.some({ type: "user.created", payload: {}, timestamp: 1, processed: true, processedAt: 2 })

Creates a channel from a PubSub that outputs arrays of values.

Details

This constructor creates a channel that reads from a PubSub by automatically subscribing to it and collecting values into arrays. The channel outputs arrays of values in chunks, making it ideal for batch processing scenarios.

Signature

declare function fromPubSubArray<A>(pubsub: PubSub<A>): Channel<readonly [A, A]>

Example Batching PubSub values

import { Channel, Data, Effect, Option, PubSub } from "effect"
class BatchError extends Data.TaggedError("BatchError")<{
readonly message: string
}> {}
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.unbounded<number>({ replay: 4 })
// Create a channel that reads arrays of values
const channel = Channel.fromPubSubArray(pubsub)
// Publish some values
yield* PubSub.publish(pubsub, 1)
yield* PubSub.publish(pubsub, 2)
yield* PubSub.publish(pubsub, 3)
yield* PubSub.publish(pubsub, 4)
// The channel will output arrays like [1, 2, 3] and [4]
return channel
})
const result = Effect.scoped(Effect.flatMap(program, Channel.runHead))
await Effect.runPromise(result) // => Option.some([1, 2, 3, 4])

Example Processing PubSub orders in batches

import { Channel, Effect, Option, PubSub } from "effect"
interface Order {
readonly id: string
readonly customerId: string
readonly items: ReadonlyArray<string>
readonly total: number
readonly submittedAt: number
}
const orderBatchProcessor = Effect.gen(function*() {
const orderPubSub = yield* PubSub.unbounded<Order>({ replay: 1 })
// Create a channel that processes orders in batches
const orderChannel = Channel.fromPubSubArray(orderPubSub)
// Transform to process each batch of orders
const processedChannel = Channel.map(orderChannel, (orderBatch) => {
const totalRevenue = orderBatch.reduce((sum, order) => sum + order.total, 0)
const customerCount = new Set(orderBatch.map((order) =>
order.customerId
)).size
return {
batchSize: orderBatch.length,
totalRevenue,
uniqueCustomers: customerCount,
firstSubmittedAt: Math.min(...orderBatch.map((order) => order.submittedAt)),
orders: orderBatch
}
})
yield* PubSub.publish(orderPubSub, {
id: "1", customerId: "a", items: ["book"], total: 10, submittedAt: 1
})
return processedChannel
})
const order = Effect.scoped(Effect.flatMap(orderBatchProcessor, Channel.runHead))
const result = await Effect.runPromise(order)
Option.map(result, (batch) => [batch.batchSize, batch.totalRevenue, batch.uniqueCustomers]) // => Option.some([1, 10, 1])

Example Processing PubSub logs in batches

import { Channel, Effect, Option, PubSub } from "effect"
interface LogEntry {
readonly timestamp: number
readonly level: "info" | "warn" | "error"
readonly message: string
readonly source: string
}
const logAggregator = Effect.gen(function*() {
const logPubSub = yield* PubSub.unbounded<LogEntry>({ replay: 1 })
// Create a channel that collects logs in batches
const logChannel = Channel.fromPubSubArray(logPubSub)
// Transform to analyze log batches
const analysisChannel = Channel.map(logChannel, (logBatch) => {
const errorCount = logBatch.filter((log) => log.level === "error").length
const warnCount = logBatch.filter((log) => log.level === "warn").length
const infoCount = logBatch.filter((log) => log.level === "info").length
const timeRange = {
start: Math.min(...logBatch.map((log) => log.timestamp)),
end: Math.max(...logBatch.map((log) => log.timestamp))
}
return {
batchId: `${timeRange.start}-${timeRange.end}`,
totalEntries: logBatch.length,
errorCount,
warnCount,
infoCount,
timeRange,
sources: [...new Set(logBatch.map((log) => log.source))]
}
})
yield* PubSub.publish(logPubSub, {
timestamp: 1,
level: "info",
message: "ready",
source: "app"
} satisfies LogEntry)
return analysisChannel
})
const log = Effect.scoped(Effect.flatMap(logAggregator, Channel.runHead))
const result = await Effect.runPromise(log)
Option.map(result, (batch) => [batch.batchId, batch.totalEntries, batch.infoCount]) // => Option.some(["1-1", 1, 1])

Subscribes to a PubSub of Take values and exposes them as a channel.

Details

Output Take values are emitted as non-empty arrays. Failed Take values fail the channel. Done Take values complete the channel.

Signature

declare function fromPubSubTake<A, E, Done>(pubsub: PubSub<Take<A, E, Done>>): Channel<readonly [A, A], E, Done>
Since v4.0.0

Creates a Channel from an Effect that produces a Pull.

Signature

declare function fromPull<OutElem, OutErr, OutDone, EX, EnvX, Env>(effect: Effect<Pull<OutElem, OutErr, OutDone, EnvX>, EX, Env>): Channel<OutElem, EX | Exclude<OutErr, Done<any>>, OutDone, unknown, unknown, unknown, EnvX | Env>

Example Creating channels from pulls

import { Cause, Channel, Effect } from "effect"
const channel = Channel.fromPull(Effect.sync(() => {
let emitted = false
return Effect.suspend(() => {
if (emitted) return Cause.done()
emitted = true
return Effect.succeed(42)
})
}))
await Effect.runPromise(Channel.runCollect(channel)) // => [42]

Creates a channel from a queue.

Signature

declare function fromQueue<A, E>(queue: Dequeue<A, E>): Channel<A, Exclude<E, Done<void>>>

Example Creating channels from queues

import { Cause, Channel, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<string, Cause.Done>(3)
yield* Queue.offerAll(queue, ["item1", "item2", "item3"])
yield* Queue.end(queue)
const channel = Channel.fromQueue(queue)
return yield* Channel.runCollect(channel)
})
await Effect.runPromise(program) // => ["item1", "item2", "item3"]

Creates a channel from a queue that emits arrays of elements.

Signature

declare function fromQueueArray<A, E>(queue: Dequeue<A, E>): Channel<readonly [A, A], Exclude<E, Done<void>>>

Example Creating batched channels from queues

import { Cause, Channel, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(4)
yield* Queue.offerAll(queue, [1, 2, 3, 4])
yield* Queue.end(queue)
const arrayChannel = Channel.fromQueueArray(queue)
return yield* Channel.runCollect(arrayChannel)
})
await Effect.runPromise(program) // => [[1, 2, 3, 4]]

Creates a channel from a lazily supplied Web ReadableStream.

Signature

declare function fromReadableStream<A, E>(options: {
readonly evaluate: LazyArg<ReadableStream<A>>;
readonly onError: (error: unknown) => E;
readonly releaseLockOnEnd?: boolean;
}): Channel<readonly [A, A], E>

Example Reading from a Web stream

import { Channel, Effect } from "effect"
const channel = Channel.fromReadableStream({
evaluate: () => new ReadableStream({
start(controller) {
controller.enqueue(1)
controller.close()
}
}),
onError: (cause) => new Error(String(cause))
})
await Effect.runPromise(Channel.runCollect(channel)) // => [[1]]

Creates a Channel from a Schedule.

Signature

declare function fromSchedule<O, E, R>(schedule: Schedule<O, unknown, E, R>): Channel<O, E, O, unknown, unknown, unknown, R>

Creates a channel from a PubSub subscription.

Signature

declare function fromSubscription<A>(subscription: Subscription<A>): Channel<A>

Example Creating channels from subscriptions

import { Channel, Data, Effect, Option, PubSub } from "effect"
class SubscriptionError extends Data.TaggedError("SubscriptionError")<{
readonly reason: string
}> {}
const program = Effect.gen(function*() {
// Create a PubSub
const pubsub = yield* PubSub.bounded<string>(32)
// Create a subscription
const subscription = yield* PubSub.subscribe(pubsub)
// Publish some messages
yield* PubSub.publish(pubsub, "Hello")
yield* PubSub.publish(pubsub, "World")
yield* PubSub.publish(pubsub, "from")
yield* PubSub.publish(pubsub, "PubSub")
// Create a channel from the subscription
const channel = Channel.fromSubscription(subscription)
// The channel will receive all published messages
return channel
})
const result = Effect.scoped(Effect.flatMap(program, Channel.runHead))
await Effect.runPromise(result) // => Option.some("Hello")
// Real-time notifications example
const notificationChannel = Effect.gen(function*() {
const eventBus = yield* PubSub.unbounded<{ type: string; payload: any }>()
const userSubscription = yield* PubSub.subscribe(eventBus)
return Channel.fromSubscription(userSubscription)
})

Creates a channel from a PubSub subscription that outputs arrays of values.

Details

This constructor creates a channel that reads from a PubSub subscription and outputs arrays of values in chunks. It's useful when you want to process multiple values at once for better performance.

Signature

declare function fromSubscriptionArray<A>(subscription: Subscription<A>): Channel<readonly [A, A]>

Example Batching subscription values

import { Channel, Data, Effect, Option, PubSub } from "effect"
class StreamError extends Data.TaggedError("StreamError")<{
readonly message: string
}> {}
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.bounded<number>(16)
const subscription = yield* PubSub.subscribe(pubsub)
// Create a channel that reads arrays of values
const channel = Channel.fromSubscriptionArray(subscription)
// Publish some values
yield* PubSub.publish(pubsub, 1)
yield* PubSub.publish(pubsub, 2)
yield* PubSub.publish(pubsub, 3)
yield* PubSub.publish(pubsub, 4)
// The channel will output arrays like [1, 2, 3] and [4]
return channel
})
const result = Effect.scoped(Effect.flatMap(program, Channel.runHead))
await Effect.runPromise(result) // => Option.some([1, 2, 3, 4])

Example Processing subscription values in batches

import { Channel, Data, Effect, Option, PubSub } from "effect"
class BatchProcessingError extends Data.TaggedError("BatchProcessingError")<{
readonly reason: string
}> {}
const batchProcessor = Effect.gen(function*() {
const pubsub = yield* PubSub.bounded<string>(32)
const subscription = yield* PubSub.subscribe(pubsub)
// Create a channel that processes items in batches
const batchChannel = Channel.fromSubscriptionArray(subscription)
// Transform to process each batch
const processedChannel = Channel.map(batchChannel, (batch) =>
batch.map((item) => item.toUpperCase())
)
yield* PubSub.publishAll(pubsub, ["one", "two"])
return processedChannel
})
const batch = Effect.scoped(Effect.flatMap(batchProcessor, Channel.runHead))
await Effect.runPromise(batch) // => Option.some(["ONE", "TWO"])

Example Aggregating subscription metrics

import { Channel, Effect, Option, PubSub } from "effect"
const metricsAggregator = Effect.gen(function*() {
const metricsPubSub = yield* PubSub.bounded<
{ timestamp: number; value: number }
>(100)
const subscription = yield* PubSub.subscribe(metricsPubSub)
// Create a channel that collects metrics in chunks
const metricsChannel = Channel.fromSubscriptionArray(subscription)
// Transform to calculate aggregate statistics
const aggregatedChannel = Channel.map(metricsChannel, (metrics) => {
const values = metrics.map((m) => m.value)
const sum = values.reduce((a, b) => a + b, 0)
const avg = sum / values.length
const min = Math.min(...values)
const max = Math.max(...values)
return {
count: values.length,
sum,
average: avg,
min,
max,
firstTimestamp: Math.min(...metrics.map((m) => m.timestamp)),
lastTimestamp: Math.max(...metrics.map((m) => m.timestamp))
}
})
yield* PubSub.publish(metricsPubSub, { timestamp: 1, value: 10 })
return aggregatedChannel
})
const metric = Effect.scoped(Effect.flatMap(metricsAggregator, Channel.runHead))
const result = await Effect.runPromise(metric)
Option.map(result, ({ count, sum, average, min, max }) => ({ count, sum, average, min, max })) // => Option.some({ count: 1, sum: 10, average: 10, min: 10, max: 10 })

Creates a Channel from a transformation function that operates on upstream pulls.

Signature

declare function fromTransform<OutElem, OutErr, OutDone, InElem, InErr, InDone, EX, EnvX, Env>(transform: (upstream: Pull<InElem, InErr, InDone>, scope: Scope) => Effect<Pull<OutElem, OutErr, OutDone, EnvX>, EX, Env>): Channel<OutElem, EX | Exclude<OutErr, Done<any>>, OutDone, InElem, InErr, InDone, EnvX | Env>

Example Creating channels from transforms

import { Channel, Effect } from "effect"
const channel = Channel.fromTransform((upstream, scope) =>
Effect.succeed(upstream)
)
await Effect.runPromise(Channel.runCollect(channel)) // => []

Creates a Channel from a transformation function that operates on upstream pulls, but also provides a forked scope that closes when the resulting Channel completes.

When to use

Use when building channels that require scoped resource lifecycle management, providing both the channel scope and a forked scope that automatically closes when the channel completes.

See

  • fromTransform for a simpler transformation without a forked scope

Signature

declare function fromTransformBracket<OutElem, OutErr, OutDone, InElem, InErr, InDone, EX, EnvX, Env>(f: (upstream: Pull<InElem, InErr, InDone>, scope: Scope, forkedScope: Scope) => Effect<Pull<OutElem, OutErr, OutDone, EnvX>, EX, Env>): Channel<OutElem, EX | Exclude<OutErr, Done<any>>, OutDone, InElem, InErr, InDone, EnvX | Env>

Creates a channel backed by a Web TransformStream, writing upstream values while emitting transformed values from its readable side.

Signature

declare function fromTransformStream<IE, I, O, E>(options: {
readonly closeOnDone?: boolean;
readonly evaluate: LazyArg<TransformStream<I, O>>;
readonly onError: (error: unknown) => E;
readonly releaseLockOnEnd?: boolean;
}): Channel<readonly [O, O], IE | E, void, readonly [I, I], IE>

Example Transforming channel input

import { Channel, Effect } from "effect"
const transform = Channel.fromTransformStream<never, number, number, Error>({
evaluate: () => new TransformStream({
transform(value, controller) {
controller.enqueue(value * 2)
}
}),
onError: (cause) => new Error(String(cause))
})
const program = Channel.fromArray([[1, 2] as [number, number]]).pipe(
Channel.pipeTo(transform),
Channel.runCollect
)
await Effect.runPromise(program) // => [[2], [4]]

Creates a channel that writes upstream values to a lazily supplied Web WritableStream.

Signature

declare function fromWritableStream<IE, E, A>(options: {
readonly closeOnDone?: boolean;
readonly evaluate: LazyArg<WritableStream<A>>;
readonly onError: (error: unknown) => E;
}): Channel<never, IE | E, void, readonly [A, A], IE>

Example Writing channel input

import { Channel, Effect } from "effect"
const written: Array<number> = []
const sink = Channel.fromWritableStream<never, Error, number>({
evaluate: () => new WritableStream({
write(value) {
written.push(value)
}
}),
onError: (cause) => new Error(String(cause))
})
const program = Channel.fromArray([[1, 2] as [number, number]]).pipe(
Channel.pipeTo(sink),
Channel.runDrain
)
await Effect.runPromise(program)
written // => [1, 2]
Since v2.0.0

Creates a channel that forwards upstream input elements, input errors, and the upstream done value unchanged.

Signature

declare function identity<Elem, Err, Done>(): Channel<Elem, Err, Done, Elem, Err, Done>
Since v2.0.0

Represents a Channel that never completes.

Signature

declare const never: Channel<never, never, never>

Example Creating non-terminating channels

import { Channel } from "effect"
// Create a channel that never completes
const neverChannel = Channel.never
// Use in conditional logic
const withFallback = Channel.concatWith(
neverChannel,
() => Channel.succeed("fallback")
)
// Never channel is useful for testing or as a placeholder
const conditionalChannel = (shouldComplete: boolean) =>
shouldComplete ? Channel.succeed("done") : Channel.never
Channel.isChannel(conditionalChannel(false)) // => true
Since v2.0.0

Creates a Channel that emits a single value and then ends.

Signature

declare function succeed<A>(value: A): Channel<A>

Example Creating channels that succeed

import { Channel, Effect } from "effect"
const channel = Channel.succeed(42)
Effect.runSync(Channel.runCollect(channel)) // => [42]
Since v2.0.0

Creates a Channel that lazily evaluates to another channel.

Signature

declare function suspend<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(evaluate: LazyArg<Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>

Example Suspending channel creation

import { Channel, Effect } from "effect"
const channel = Channel.suspend(() => Channel.succeed(42))
Effect.runSync(Channel.runCollect(channel)) // => [42]
Since v2.0.0

Creates a Channel that emits a single value computed by a lazy evaluation.

Signature

declare function sync<A>(evaluate: LazyArg<A>): Channel<A>

Example Computing values lazily

import { Channel, Effect } from "effect"
let requests = 0
const channel = Channel.sync(() => {
requests += 1
return `request-${requests}`
})
Effect.runSync(Channel.runCollect(channel)) // => ["request-1"]

Transforms a Channel by applying a function to its Pull implementation.

Signature

declare function transformPull<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, Env2, OutErrX, EnvX>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (pull: Pull<OutElem, OutErr, OutDone>, scope: Scope) => Effect<Pull<OutElem2, OutErr2, OutDone2, Env2>, OutErrX, EnvX>): Channel<OutElem2, OutErrX | Exclude<OutErr2, Done<any>>, OutDone2, InElem, InErr, InDone, Env | Env2 | EnvX>

Example Transforming pull behavior

import { Channel, Effect } from "effect"
// Transform a channel by modifying its pull behavior
const originalChannel = Channel.fromIterable([1, 2, 3])
const transformedChannel = Channel.transformPull(
originalChannel,
(pull, scope) =>
Effect.succeed(
Effect.map(pull, (value) => value * 2)
)
)
await Effect.runPromise(Channel.runCollect(transformedChannel)) // => [2, 4, 6]
Since v2.0.0

Constructs a Channel from a scoped effect that will result in a Channel if successful.

Signature

declare function unwrap<OutElem, OutErr, OutDone, InElem, InErr, InDone, R2, E, R>(channel: Effect<Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, R2>, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, R2 | Exclude<R, Scope>>

Example Unwrapping channel effects

import { Channel, Data, Effect } from "effect"
class UnwrapError extends Data.TaggedError("UnwrapError")<{
readonly reason: string
}> {}
// Create an effect that produces a channel
const channelEffect = Effect.succeed(
Channel.fromIterable([1, 2, 3])
)
// Unwrap the effect to get the channel
const unwrappedChannel = Channel.unwrap(channelEffect)
Effect.runSync(Channel.runCollect(unwrappedChannel)) // => [1, 2, 3]

Decoding

Decodes incoming Uint8Array chunks into strings using TextDecoder.

Details

Input chunks are decoded with streaming enabled so multi-byte characters may span Uint8Array boundaries. The optional encoding and options are passed to TextDecoder.

Signature

declare function decodeText<Err, Done>(encoding?: string, options?: TextDecoderOptions): Channel<readonly [string, string], Err, Done, readonly [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>], Err, Done>

Destructors

Runs a channel and publishes each output element to a PubSub.

Details

The channel's output values are published as individual PubSub messages. Use options.shutdownOnEnd to shut down the PubSub when channel execution ends.

Signature

declare const runIntoPubSub: {
<OutElem>(pubsub: PubSub<OutElem>, options?: {
readonly shutdownOnEnd?: boolean;
}): <OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<void, OutErr, Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, pubsub: PubSub<OutElem>, options?: {
readonly shutdownOnEnd?: boolean;
}): Effect<void, OutErr, Env>;
}

Runs an array-emitting channel and publishes each array element to a PubSub.

Details

Each element inside emitted non-empty arrays is published as an individual PubSub message. Use options.shutdownOnEnd to shut down the PubSub when channel execution ends.

Signature

declare const runIntoPubSubArray: {
<OutElem>(pubsub: PubSub<OutElem>, options?: {
readonly shutdownOnEnd?: boolean;
}): <OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<OutDone, OutErr, Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>, pubsub: PubSub<OutElem>, options?: {
readonly shutdownOnEnd?: boolean;
}): Effect<OutDone, OutErr, Env>;
}

Runs a channel and offers each output element into a queue.

Details

When the channel completes, the queue is ended. When the channel fails, the queue is failed with the channel's cause. The returned effect itself completes with void.

Signature

declare const runIntoQueue: {
<OutElem, OutErr>(queue: Queue<OutElem, Done<void> | OutErr>): <OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<void, never, Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, queue: Queue<OutElem, Done<void> | OutErr>): Effect<void, never, Env>;
}

Runs a channel that emits non-empty arrays and offers each array element into a queue.

Details

When the channel completes, the queue is ended. When the channel fails, the queue is failed with the channel's cause. The returned effect itself completes with void.

Signature

declare const runIntoQueueArray: {
<OutElem, OutErr>(queue: Queue<OutElem, Done<void> | OutErr>): <OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<void, never, Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>, queue: Queue<OutElem, Done<void> | OutErr>): Effect<void, never, Env>;
}
Since v2.0.0

Converts a channel to a PubSub for concurrent consumption.

Details

shutdownOnEnd indicates whether the PubSub should be shut down when the channel ends. By default this is true.

Signature

declare const toPubSub: {
(options: {
readonly capacity: "unbounded";
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
} | {
readonly capacity: number;
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<PubSub<OutElem>, never, Scope | Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, options: {
readonly capacity: "unbounded";
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
} | {
readonly capacity: number;
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Effect<PubSub<OutElem>, never, Scope | Env>;
}

Converts an array-emitting channel to a scoped PubSub for concurrent consumption.

Details

Each element inside emitted non-empty arrays is published as an individual PubSub message. shutdownOnEnd indicates whether the PubSub should be shut down when the channel ends. By default this is true.

Signature

declare const toPubSubArray: {
(options: {
readonly capacity: "unbounded";
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
} | {
readonly capacity: number;
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<PubSub<OutElem>, never, Scope | Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>, options: {
readonly capacity: "unbounded";
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
} | {
readonly capacity: number;
readonly replay?: number;
readonly shutdownOnEnd?: boolean;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Effect<PubSub<OutElem>, never, Scope | Env>;
}

Converts a channel to a scoped PubSub of Take values.

Details

Emitted non-empty arrays are published as output Take values. When the channel ends, the PubSub is ended with its final Exit, so every subscriber, including one that subscribes later, observes completion or failure once it has consumed its buffered values.

Signature

declare const toPubSubTake: {
(options: {
readonly capacity: "unbounded";
readonly replay?: number;
} | {
readonly capacity: number;
readonly replay?: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutDone, OutDone], OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<PubSub<Take<OutElem, OutErr, OutDone>>, never, Scope | Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>, options: {
readonly capacity: "unbounded";
readonly replay?: number;
} | {
readonly capacity: number;
readonly replay?: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Effect<PubSub<Take<OutElem, OutErr, OutDone>>, never, Scope | Env>;
}
Since v2.0.0

Converts a channel to a scoped Pull for low-level consumption.

Details

The effect requires a Scope. The returned pull should be consumed only while that scope remains open. Pulls are serialized so only one pull is evaluated at a time.

Signature

declare const toPull: <OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect.Effect<Pull.Pull<OutElem, OutErr, OutDone>, never, Env | Scope.Scope>

Example Converting channels to pulls

import { Channel, Data, Effect } from "effect"
class PullError extends Data.TaggedError("PullError")<{
readonly step: string
}> {}
// Create a channel
const numbersChannel = Channel.fromIterable([1, 2, 3])
const program = Effect.scoped(Effect.gen(function*() {
const pull = yield* Channel.toPull(numbersChannel)
return [yield* pull, yield* pull, yield* pull]
}))
await Effect.runPromise(program) // => [1, 2, 3]

Converts a channel to a Pull within an existing scope.

Signature

declare function toPullScoped<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, scope: Scope): Effect<Pull<OutElem, OutErr, OutDone, Env>, never, Env>

Example Converting channels to scoped pulls

import { Channel, Data, Effect, Scope } from "effect"
class ScopedPullError extends Data.TaggedError("ScopedPullError")<{
readonly reason: string
}> {}
// Create a channel
const numbersChannel = Channel.fromIterable([1, 2, 3])
// Convert to Pull with explicit scope
const scopedPullEffect = Effect.gen(function*() {
const scope = yield* Effect.scope
const pull = yield* Channel.toPullScoped(numbersChannel, scope)
return [yield* pull, yield* pull, yield* pull]
})
await Effect.runPromise(Effect.scoped(scopedPullEffect)) // => [1, 2, 3]
Since v2.0.0

Creates a scoped queue and forks the channel to feed it for concurrent consumption.

Details

Output elements are offered to the queue. Channel completion and failure are signaled through the queue. The queue is shut down when the surrounding scope closes.

Signature

declare const toQueue: {
(options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<Dequeue<OutElem, Done<void> | OutErr>, never, Scope | Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Effect<Dequeue<OutElem, Done<void> | OutErr>, never, Scope | Env>;
}

Example Converting channels to queues

import { Channel, Data, Effect, Queue } from "effect"
class QueueError extends Data.TaggedError("QueueError")<{
readonly operation: string
}> {}
// Create a channel with data
const dataChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Convert to queue for concurrent processing
const program = Effect.scoped(Effect.gen(function*() {
const queue = yield* Channel.toQueue(dataChannel, { capacity: 32 })
return yield* Queue.takeBetween(queue, 5, 5)
}))
await Effect.runPromise(program) // => [1, 2, 3, 4, 5]

Creates a scoped queue and forks an array-emitting channel to feed it.

Details

Each element inside emitted non-empty arrays is offered to the queue. Channel completion and failure are signaled through the queue. The queue is shut down when the surrounding scope closes.

Signature

declare const toQueueArray: {
(options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): <OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<Dequeue<OutElem, Done<void> | OutErr>, never, Scope | Env>;
<OutElem, OutErr, OutDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, unknown, unknown, unknown, Env>, options: {
readonly capacity: "unbounded";
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend";
}): Effect<Dequeue<OutElem, Done<void> | OutErr>, never, Scope | Env>;
}

Converts a Channel back to its underlying transformation function.

Signature

declare function toTransform<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(channel: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>): (upstream: Pull<InElem, InErr, InDone>, scope: Scope) => Effect<Pull<OutElem, OutErr, OutDone, never>, never, Env>

Example Extracting channel transforms

import { Channel, Effect } from "effect"
const channel = Channel.succeed(42)
const transform = Channel.toTransform(channel)
typeof transform // => "function"
Effect.runSync(Channel.runCollect(channel)) // => [42]

Encoding

Encodes incoming string chunks into Uint8Array values using TextEncoder.

Details

Each string inside an emitted array is encoded independently.

Signature

declare function encodeText<Err, Done>(): Channel<readonly [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>], Err, Done, readonly [string, string], Err, Done>

Error Handling

Catches any cause of failure from the channel and allows recovery by creating a new channel based on the caught cause.

Signature

declare const catchCause: {
<OutErr, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (d: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Recovering from failure causes

import { Cause, Channel, Data, Effect } from "effect"
class ProcessError extends Data.TaggedError("ProcessError")<{
readonly reason: string
}> {}
class RecoveryError extends Data.TaggedError("RecoveryError")<{
readonly message: string
}> {}
// Create a failing channel
const failingChannel = Channel.fail(
new ProcessError({ reason: "network error" })
)
// Catch the cause and provide recovery
const recoveredChannel = Channel.catchCause(failingChannel, (cause) => {
if (Cause.hasFails(cause)) {
return Channel.succeed("Recovered from failure")
}
return Channel.succeed("Recovered from interruption")
})
Effect.runSync(Channel.runCollect(recoveredChannel)) // => ["Recovered from failure"]

Recovers from channel failures whose full Cause is selected by a Filter.

When to use

Use when you need to recover a channel only from causes selected by a Filter, while giving the recovery both the selected value and the original Cause.

Details

When the filter succeeds, the recovery function receives the selected value and the original cause. When the filter fails, the returned channel fails with the residual cause produced by the filter.

See

Signature

declare const catchCauseFilter: {
<OutErr, EB, X extends Cause<any>, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(filter: Filter<Cause<OutErr>, EB, X>, f: (failure: EB, cause: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | Error<X>, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, EB, X extends Cause<any>, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, filter: Filter<Cause<OutErr>, EB, X>, f: (failure: EB, cause: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr1 | Error<X>, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Catches causes of failure that match a specific filter, allowing conditional error recovery based on the type of failure.

When to use

Use to recover a channel only when its full Cause satisfies a boolean predicate.

Details

When the predicate matches, the recovery function receives the original cause. When it does not match, the returned channel fails with the original cause.

See

Signature

declare const catchCauseIf: {
<OutErr, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(predicate: Predicate<Cause<OutErr>>, f: (cause: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr | OutErr1, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: Predicate<Cause<OutErr>>, f: (cause: Cause<OutErr>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Recovers from defects using the provided function.

Details

Typed failures and interruptions are not caught.

Signature

declare const catchDefect: {
<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (defect: unknown) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | OutErr, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (defect: unknown) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Recovering from a defect

import { Channel, Effect } from "effect"
const channel = Channel.fromEffect(Effect.die("boom")).pipe(
Channel.catchDefect((defect) => Channel.succeed(`recovered: ${defect}`))
)
Effect.runSync(Channel.runCollect(channel)) // => ["recovered: boom"]

Recovers from typed channel errors selected by a Filter.

When to use

Use to recover from channel errors with a reusable Filter when matching can also narrow or transform the error before choosing the recovery channel.

Details

Successful filter results are handled by the recovery function. Failed filter results are handled by orElse when provided. Without orElse, failed filter results are re-failed.

See

Signature

declare const catchFilter: {
<OutErr, EB, X, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(filter: Filter<OutErr, EB, X>, f: (failure: EB) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: X) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? X : never, OutDone1 | OutDone2 | OutDone, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, EB, X, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, filter: Filter<OutErr, EB, X>, f: (failure: EB) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: X) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | OutElem1 | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? X : never, OutDone | OutDone1 | OutDone2, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env | Env1 | Env2>;
}
Since v4.0.0

Recovers from typed channel errors that match a predicate or refinement.

When to use

Use to recover from typed channel errors when a predicate or refinement selects the failures that should switch to a recovery channel.

Details

Matching errors are handled by the recovery function. Non-matching errors are handled by orElse when provided. Without orElse, non-matching errors are re-failed.

See

  • catch for recovering from every typed channel error
  • catchFilter for selecting typed errors with a Filter
  • catchTag for selecting tagged typed errors
  • catchCauseFilter for selecting full causes with a Filter

Signature

declare const catchIf: {
<OutErr, EB, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(refinement: Refinement<OutErr, EB>, f: (failure: EB) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: Exclude<OutErr, EB>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? Exclude<OutErr, EB> : never, OutDone1 | OutDone2 | OutDone, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
<OutErr, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(predicate: Predicate<OutErr>, f: (failure: OutErr) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: OutErr) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? OutErr : never, OutDone1 | OutDone2 | OutDone, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, EB, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, refinement: Refinement<OutErr, EB>, f: (failure: EB) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: Exclude<OutErr, EB>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | OutElem1 | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? Exclude<OutErr, EB> : never, OutDone | OutDone1 | OutDone2, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env | Env1 | Env2>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: Predicate<OutErr>, f: (failure: OutErr) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (failure: OutErr) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | OutElem1 | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? OutErr : never, OutDone | OutDone1 | OutDone2, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env | Env1 | Env2>;
}

Catches a specific reason within a tagged error.

Signature

declare const catchReason: {
<OutErr, K extends string, RK extends string, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(errorTag: K, reasonTag: RK, f: (reason: ExtractReason<ExtractTag<NoInfer<OutErr>, K>, RK>, error: NarrowReason<ExtractTag<NoInfer<OutErr>, K>, RK>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (reason: ExcludeReason<ExtractTag<NoInfer<OutErr>, K>, RK>, error: OmitReason<ExtractTag<NoInfer<OutErr>, K>, RK>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | Exclude<OutErr, {
readonly _tag: K;
}> | OutElem2 extends unassigned ? ExtractTag<OutErr, K> : never, OutDone1 | OutDone2 | OutDone, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, K extends string, RK extends string, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, errorTag: K, reasonTag: RK, f: (reason: ExtractReason<ExtractTag<NoInfer<OutErr>, K>, RK>, error: NarrowReason<ExtractTag<NoInfer<OutErr>, K>, RK>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (reason: ExcludeReason<ExtractTag<NoInfer<OutErr>, K>, RK>, error: OmitReason<ExtractTag<NoInfer<OutErr>, K>, RK>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | OutElem1 | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | Exclude<OutErr, {
readonly _tag: K;
}> | OutElem2 extends unassigned ? ExtractTag<OutErr, K> : never, OutDone | OutDone1 | OutDone2, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env | Env1 | Env2>;
}

Example Recovering from nested reasons

import { Channel, Data, Effect } from "effect"
class RateLimitError extends Data.TaggedError("RateLimitError")<{
retryAfter: number
}> {}
class QuotaExceededError extends Data.TaggedError("QuotaExceededError")<{
limit: number
}> {}
class AiError extends Data.TaggedError("AiError")<{
reason: RateLimitError | QuotaExceededError
}> {}
const reason = new RateLimitError({ retryAfter: 60 })
const channel = Channel.fail(new AiError({ reason }))
const recovered = channel.pipe(
Channel.catchReason("AiError", "RateLimitError", (reason) =>
Channel.succeed(`retry: ${reason.retryAfter}`)
)
)
Effect.runSync(Channel.runCollect(recovered)) // => ["retry: 60"]

Catches multiple reasons within a tagged error using an object of handlers.

Signature

declare const catchReasons: {
<K extends string, OutErr, Cases extends { [RK in string]: (reason: ExtractReason<ExtractTag<NoInfer<OutErr>, K>, RK>, error: NarrowReason<ExtractTag<NoInfer<OutErr>, K>, RK>) => Channel<any, any, any, any, any, any, any> }, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(errorTag: K, cases: Cases, orElse?: (reason: ExcludeReason<ExtractTag<NoInfer<OutErr>, K>, Extract<keyof Cases, string>>, error: OmitReason<ExtractTag<NoInfer<OutErr>, K>, Extract<keyof Cases, string>>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem | Exclude<OutElem2, unassigned> | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<OutElem1, any, any, any, any, any, any> ? OutElem1 : never }[keyof Cases], OutErr2 | Exclude<OutErr, {
readonly _tag: K;
}> | OutElem2 extends unassigned ? ExtractTag<OutErr, K> : never | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, OutErr1, any, any, any, any, any> ? OutErr1 : never }[keyof Cases], OutDone2 | OutDone | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, OutDone1, any, any, any, any> ? OutDone1 : never }[keyof Cases], InElem & InElem2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, InElem1, any, any, any> ? InElem1 : never }[keyof Cases], InErr & InErr2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, InErr1, any, any> ? InErr1 : never }[keyof Cases], InDone & InDone2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, any, InDone1, any> ? InDone1 : never }[keyof Cases], Env2 | Env | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, any, any, Env1> ? Env1 : never }[keyof Cases]>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, K extends string, Cases extends { [RK in string]: (reason: ExtractReason<ExtractTag<OutErr, K>, RK>, error: NarrowReason<ExtractTag<OutErr, K>, RK>) => Channel<any, any, any, any, any, any, any> }, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, errorTag: K, cases: Cases, orElse?: (reason: ExcludeReason<ExtractTag<NoInfer<OutErr>, K>, Extract<keyof Cases, string>>, error: OmitReason<ExtractTag<NoInfer<OutErr>, K>, Extract<keyof Cases, string>>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | Exclude<OutElem2, unassigned> | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<OutElem1, any, any, any, any, any, any> ? OutElem1 : never }[keyof Cases], OutErr2 | Exclude<OutErr, {
readonly _tag: K;
}> | OutElem2 extends unassigned ? ExtractTag<OutErr, K> : never | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, OutErr1, any, any, any, any, any> ? OutErr1 : never }[keyof Cases], OutDone | OutDone2 | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, OutDone1, any, any, any, any> ? OutDone1 : never }[keyof Cases], InElem & InElem2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, InElem1, any, any, any> ? InElem1 : never }[keyof Cases], InErr & InErr2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, InErr1, any, any> ? InErr1 : never }[keyof Cases], InDone & InDone2 & { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, any, InDone1, any> ? InDone1 : never }[keyof Cases], Env | Env2 | { [RK in string | number | symbol]: Cases[RK] extends (...args: Array<any>) => Channel<any, any, any, any, any, any, Env1> ? Env1 : never }[keyof Cases]>;
}
Since v4.0.0

Recovers from tagged channel errors whose _tag matches one or more tags.

Details

Matching tagged errors are handled by the recovery function. Non-matching errors are handled by orElse when provided. Without orElse, non-matching errors are re-failed.

Signature

declare const catchTag: {
<OutErr, K extends string | readonly [Tags<OutErr>, Tags<OutErr>], OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(k: K, f: (e: ExtractTag<NoInfer<OutErr>, K extends readonly [string, string] ? K[number] : K>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (e: Exclude<NoInfer<OutErr>, {
readonly _tag: K;
}>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? Exclude<OutErr, {
readonly _tag: K;
}> : never, OutDone1 | OutDone2 | OutDone, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, K extends string | readonly [Tags<OutErr>, Tags<OutErr>], OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutElem2 = unassigned, OutErr2 = never, OutDone2 = never, InElem2 = unknown, InErr2 = unknown, InDone2 = unknown, Env2 = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, k: K, f: (e: ExtractTag<NoInfer<OutErr>, K extends readonly [string, string] ? K[number] : K>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, orElse?: (e: Exclude<NoInfer<OutErr>, {
readonly _tag: K;
}>) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>): Channel<OutElem | OutElem1 | Exclude<OutElem2, unassigned>, OutErr1 | OutErr2 | OutElem2 extends unassigned ? Exclude<OutErr, {
readonly _tag: K;
}> : never, OutDone | OutDone1 | OutDone2, InElem & InElem1 & InElem2, InErr & InErr1 & InErr2, InDone & InDone1 & InDone2, Env | Env1 | Env2>;
}
Since v4.0.0

Ignores all errors in the channel, converting them to an empty channel.

Details

Use the log option to emit the full Cause when the channel fails.

Signature

declare const ignore: <Arg extends Channel<any, any, any, any, any, any, any> | {
readonly log?: boolean | Severity;
} | undefined = {
readonly log?: boolean | Severity;
}>(selfOrOptions: Arg, options?: {
readonly log?: boolean | Severity;
}) => [Arg] extends [Channel<infer OutElem, infer _OutErr, infer OutDone, infer InElem, infer InErr, infer InDone, infer Env>] ? Channel<OutElem, never, OutDone | void, InElem, InErr, InDone, Env> : <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, never, OutDone | void, InElem, InErr, InDone, Env>

Ignores all errors in the channel including defects, converting them to an empty channel.

When to use

Use when a channel should become best-effort and all failure causes, including defects and interruptions, can be converted to empty output.

Details

Use the log option to emit the full Cause when the channel fails.

Signature

declare const ignoreCause: <Arg extends Channel<any, any, any, any, any, any, any> | {
readonly log?: boolean | Severity;
} | undefined = {
readonly log?: boolean | Severity;
}>(selfOrOptions: Arg, options?: {
readonly log?: boolean | Severity;
}) => [Arg] extends [Channel<infer OutElem, infer _OutErr, infer OutDone, infer InElem, infer InErr, infer InDone, infer Env>] ? Channel<OutElem, never, OutDone | void, InElem, InErr, InDone, Env> : <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, never, OutDone | void, InElem, InErr, InDone, Env>
Since v2.0.0

Returns a new channel, which is the same as this one, except the failure value of the returned channel is created by applying the specified function to the failure value of this channel.

Signature

declare const mapError: {
<OutErr, OutErr2>(f: (err: OutErr) => OutErr2): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr2, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutErr2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (err: OutErr) => OutErr2): Channel<OutElem, OutErr2, OutDone, InElem, InErr, InDone, Env>;
}
Since v4.0.0

Attaches a finalizer that runs only when the channel exits with failure.

Details

The finalizer receives the failure Cause. The original channel failure is preserved. The finalizer itself must not fail.

Signature

declare const onError: {
<OutDone, OutErr, Env2>(finalizer: (cause: Cause<OutErr>) => Effect<unknown, never, Env2>): <OutElem, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, finalizer: (cause: Cause<OutErr>) => Effect<unknown, never, Env2>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env | Env2>;
}
Since v2.0.0

Converts all errors in the channel to defects (unrecoverable failures). This is useful when you want to treat errors as programming errors.

Signature

declare function orDie<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>): Channel<OutElem, never, OutDone, InElem, InErr, InDone, Env>

Example Converting failures to defects

import { Cause, Channel, Data, Effect, Exit } from "effect"
class ValidationError extends Data.TaggedError("ValidationError")<{
readonly field: string
}> {}
// Create a channel that might fail
const error = new ValidationError({ field: "email" })
const failingChannel = Channel.fail(error)
// Convert failures to defects
const fatalChannel = Channel.orDie(failingChannel)
Effect.runSync(Effect.exit(Channel.runCollect(fatalChannel))) // => Exit.failCause(Cause.die(error))
Since v4.0.0

Returns a new channel that retries this channel according to the specified schedule whenever it fails.

Signature

declare const retry: {
<SO, OutErr, SE, SR>(schedule: Schedule<SO, NoInfer<OutErr>, SE, SR> | ($: <SO, SE, SR>(_: Schedule<SO, NoInfer<OutErr>, SE, SR>) => Schedule<SO, OutErr, SE, SR>) => Schedule<SO, NoInfer<OutErr>, SE, SR>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr | SE, OutDone, InElem, InErr, InDone, SR | Env>) => Channel<OutElem, OutErr | SE, OutDone, InElem, InErr, InDone, SR | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, schedule: Schedule<SO, OutErr, SE, SR> | ($: <SO, SE, SR>(_: Schedule<SO, NoInfer<OutErr>, SE, SR>) => Schedule<SO, OutErr, SE, SR>) => Schedule<SO, NoInfer<OutErr>, SE, SR>): Channel<OutElem, OutErr | SE, OutDone, InElem, InErr, InDone, Env | SR>;
}
Since v4.0.0

Runs an effect with the full failure Cause when the channel fails, then fails the returned channel with the original cause.

When to use

Use when observing the full channel failure Cause is needed without changing successful output or replacing the original cause.

Details

Use this for observing failures, such as logging or metrics. If the observer effect fails, that failure can fail the returned channel.

Signature

declare const tapCause: {
<OutErr, A, E, R>(f: (d: Cause<OutErr>) => Effect<A, E, R>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr | E, void | OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: Cause<OutErr>) => Effect<A, E, R>): Channel<OutElem, OutErr | E, void | OutDone, InElem, InErr, InDone, Env | R>;
}
Since v4.0.0

Runs an effect when the channel fails with a typed error, then preserves the original channel failure.

Details

The effect is not run for normal channel completion. If the observer effect fails, that failure can fail the returned channel.

Signature

declare const tapError: {
<OutErr, A, E, R>(f: (d: OutErr) => Effect<A, E, R>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr | E, void | OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: OutErr) => Effect<A, E, R>): Channel<OutElem, OutErr | E, void | OutDone, InElem, InErr, InDone, Env | R>;
}

Promotes nested reason errors into the channel error, replacing the parent error.

Signature

declare const unwrapReason: {
<K extends string, OutErr>(errorTag: K): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, Exclude<OutErr, {
readonly _tag: K;
}> | ReasonOf<ExtractTag<OutErr, K>>, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, K extends string>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, errorTag: K): Channel<OutElem, Exclude<OutErr, {
readonly _tag: K;
}> | ReasonOf<ExtractTag<OutErr, K>>, OutDone, InElem, InErr, InDone, Env>;
}

Example Promoting nested reasons

import { Channel, Data, Effect, Exit } from "effect"
class RateLimitError extends Data.TaggedError("RateLimitError")<{
retryAfter: number
}> {}
class QuotaExceededError extends Data.TaggedError("QuotaExceededError")<{
limit: number
}> {}
class AiError extends Data.TaggedError("AiError")<{
reason: RateLimitError | QuotaExceededError
}> {}
const reason = new RateLimitError({ retryAfter: 60 })
const channel = Channel.fail(new AiError({ reason }))
const unwrapped = channel.pipe(Channel.unwrapReason("AiError"))
Effect.runSync(Effect.exit(Channel.runCollect(unwrapped))) // => Exit.fail(reason)

Filtering

Since v4.0.0

Filters the output elements of a channel using a predicate function. Elements that don't match the predicate are discarded.

Signature

declare const filter: {
<OutElem, B>(refinement: Refinement<OutElem, B>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<B, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem>(predicate: Predicate<OutElem>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, refinement: Refinement<OutElem, B>): Channel<B, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: Predicate<OutElem>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Example Filtering channel output

import { Channel, Effect } from "effect"
// Create a channel with mixed numbers
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5, 6, 7, 8])
// Filter to keep only even numbers
const evenChannel = Channel.filter(numbersChannel, (n) => n % 2 === 0)
Effect.runSync(Channel.runCollect(evenChannel)) // => [2, 4, 6, 8]
// Filter with type refinement
const mixedChannel = Channel.fromIterable([1, "hello", 2, "world", 3])
const numbersOnlyChannel = Channel.filter(
mixedChannel,
(value): value is number => typeof value === "number"
)
Effect.runSync(Channel.runCollect(numbersOnlyChannel)) // => [1, 2, 3]

Filters arrays of elements emitted by a channel, applying the filter to each element within the arrays and only emitting non-empty filtered arrays.

Signature

declare const filterArray: {
<OutElem, B>(refinement: Refinement<OutElem, B>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [B, B], OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem>(predicate: Predicate<NoInfer<OutElem>>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, refinement: Refinement<OutElem, B>): Channel<readonly [B, B], OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: Predicate<NoInfer<OutElem>>): Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Example Filtering array output

import { Array, Channel, Effect } from "effect"
const nonEmptyArrayPredicate = Array.isReadonlyArrayNonEmpty
// Create a channel that outputs arrays of mixed data
const arrayChannel = Channel.fromIterable([
Array.make(1, 2, 3, 4, 5),
Array.make(6, 7, 8, 9, 10),
Array.make(11, 12, 13, 14, 15)
]).pipe(Channel.filter(nonEmptyArrayPredicate))
// Filter arrays to keep only even numbers
const evenArraysChannel = Channel.filterArray(arrayChannel, (n) => n % 2 === 0)
Effect.runSync(Channel.runCollect(evenArraysChannel)) // => [[2, 4], [6, 8, 10], [12, 14]]
// Note: Only non-empty filtered arrays are emitted
// Arrays that would become empty after filtering are discarded entirely
const oddChannel = Channel.fromIterable([
Array.make(1, 3, 5),
Array.make(2, 4),
Array.make(7, 9)
]).pipe(Channel.filter(nonEmptyArrayPredicate))
const filteredOddChannel = Channel.filterArray(oddChannel, (n) => n % 2 === 0)
Effect.runSync(Channel.runCollect(filteredOddChannel)) // => [[2, 4]]

Filters each element inside emitted non-empty arrays with an effectful predicate.

When to use

Use when filtering array-valued channel outputs requires Effects or services, and arrays that become empty should be skipped.

Details

The predicate receives the element and its index within the array. Elements for which the predicate succeeds with true are kept. Arrays that become empty are discarded. Predicate failures fail the returned channel.

Signature

declare const filterArrayEffect: {
<OutElem, E, R>(predicate: (a: NoInfer<OutElem>, index: number) => Effect<boolean, E, R>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [OutElem, OutElem], E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, E, R>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: (a: NoInfer<OutElem>, index: number) => Effect<boolean, E, R>): Channel<readonly [OutElem, OutElem], OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Filters output elements with an effectful predicate.

When to use

Use when the keep/discard decision depends on an Effect or service and predicate failures should fail the returned channel.

Details

Elements for which the predicate succeeds with true are emitted. Elements for which the predicate succeeds with false are discarded. Predicate failures fail the returned channel.

Signature

declare const filterEffect: {
<OutElem, E, R>(predicate: (a: OutElem) => Effect<boolean, E, R>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, predicate: (a: OutElem) => Effect<boolean, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Filters and maps output elements using a Filter.

When to use

Use to keep only channel output elements accepted by a Filter and emit each filter success value.

Details

Successful filter results are emitted as mapped values. Failed filter results are discarded. The source channel's errors and done value are preserved.

See

Signature

declare const filterMap: {
<OutElem, B, X>(filter: Filter<OutElem, B, X>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<B, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B, X>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, filter: Filter<OutElem, B, X>): Channel<B, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Filters and maps each element inside emitted non-empty arrays using a Filter.

Details

Successful filter results are kept as mapped values. Failed filter results are removed from the array. Arrays that become empty are discarded.

Signature

declare const filterMapArray: {
<OutElem, B, X>(filter: Filter<NoInfer<OutElem>, B, X>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [B, B], OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B, X>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, filter: Filter<OutElem, B, X>): Channel<readonly [B, B], OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Filters and maps each element inside emitted non-empty arrays using an effectful Filter.

When to use

Use when array-valued channel outputs need an effectful filter-map that can fail and can discard arrays that become empty.

Details

Successful filter results are kept as mapped values. Failed filter results are removed from the array. Arrays that become empty are discarded. Failures from the effectful filter fail the returned channel.

Signature

declare const filterMapArrayEffect: {
<OutElem, B, X, EX, RX>(filter: FilterEffect<NoInfer<OutElem>, B, X, EX, RX>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<readonly [B, B], EX | OutErr, OutDone, InElem, InErr, InDone, RX | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B, X, EX, RX>(self: Channel<readonly [OutElem, OutElem], OutErr, OutDone, InElem, InErr, InDone, Env>, filter: FilterEffect<OutElem, B, X, EX, RX>): Channel<readonly [B, B], OutErr | EX, OutDone, InElem, InErr, InDone, Env | RX>;
}

Filters and maps output elements using an effectful Filter.

When to use

Use to apply effectful logic that can discard channel output elements and emit transformed values for the elements that pass.

Details

Successful filter results are emitted as mapped values. Failed filter results are discarded. Failures from the effectful filter fail the returned channel.

See

Signature

declare const filterMapEffect: {
<OutElem, B, X, EX, RX>(filter: FilterEffect<OutElem, B, X, EX, RX>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<B, EX | OutErr, OutDone, InElem, InErr, InDone, RX | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, B, X, EX, RX>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, filter: FilterEffect<OutElem, B, X, EX, RX>): Channel<B, OutErr | EX, OutDone, InElem, InErr, InDone, Env | RX>;
}

Guards

Checks whether a value is a Channel.

Signature

declare function isChannel(u: unknown): u is Channel<unknown, unknown, unknown, unknown, unknown, unknown, unknown>

Example Checking for channels

import { Channel } from "effect"
const channel = Channel.succeed(42)
Channel.isChannel(channel) // => true
Channel.isChannel("not a channel") // => false

Hooks

Since v4.0.0

Runs an effect when the channel completes successfully.

Details

The effect runs before the original done value is propagated. The effect is not run when the channel fails. If the effect fails, the returned channel fails with that error.

Signature

declare const onEnd: {
<A, E, R>(onEnd: Effect<A, E, R>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, onEnd: Effect<A, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}
Since v4.0.0

Runs an effect the first time the channel emits an output element.

When to use

Use when initialization depends on the first output element rather than only on channel startup.

Details

The effect receives the first emitted element. The first element is still emitted unchanged. The effect is not run if the channel completes without emitting an element.

Signature

declare const onFirst: {
<OutElem, A, E, R>(onFirst: (element: NoInfer<OutElem>) => Effect<A, E, R>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, onFirst: (element: NoInfer<OutElem>) => Effect<A, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}
Since v4.0.0

Runs an effect before the channel starts.

Details

The effect's successful value is ignored. If the effect fails, the returned channel fails before running the source channel.

Signature

declare const onStart: {
<A, E, R>(onStart: Effect<A, E, R>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, onStart: Effect<A, E, R>): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Interruption

Since v4.0.0

Stops a channel when the specified effect completes or fails.

Details

If the effect completes before the channel is done, its success value becomes the returned channel's done value. If the effect fails, the returned channel fails with that error. If the channel completes first, the channel's done value is preserved.

Signature

declare const haltWhen: {
<OutDone2, OutErr2, Env2>(effect: Effect<OutDone2, OutErr2, Env2>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr2 | OutErr, OutDone2 | OutDone, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2, OutErr2, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, effect: Effect<OutDone2, OutErr2, Env2>): Channel<OutElem, OutErr | OutErr2, OutDone | OutDone2, InElem, InErr, InDone, Env | Env2>;
}

Interrupts a channel when another effect completes.

When to use

Use to race channel execution against an external effect whose success can become the channel's done value.

Details

If the effect completes first, its success value becomes the returned channel's done value. If the channel completes first, the original channel's done value is preserved.

Signature

declare const interruptWhen: {
<OutDone2, OutErr2, Env2>(effect: Effect<OutDone2, OutErr2, Env2>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr2 | OutErr, OutDone2 | OutDone, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2, OutErr2, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, effect: Effect<OutDone2, OutErr2, Env2>): Channel<OutElem, OutErr | OutErr2, OutDone | OutDone2, InElem, InErr, InDone, Env | Env2>;
}

Mapping

Since v4.0.0

Wraps each output element in an object under the specified field name.

When to use

Use when you need to start a Channel Do-notation chain from an existing output value by assigning that value to a field name.

See

  • Do for starting Do notation from an empty object
  • bind for adding a field produced by another channel
  • let for adding a computed field

Signature

declare const bindTo: {
<N extends string>(name: N): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<{ [K in string]: OutElem }, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, N extends string>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, name: N): Channel<{ [K in string]: OutElem }, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Models

Channel

interface
Since v2.0.0

A Channel is a nexus of I/O operations, which supports both reading and writing. A channel may read values of type InElem and write values of type OutElem. When the channel finishes, it yields a value of type OutDone. A channel may fail with a value of type OutErr.

Details

Channels are the foundation of Streams: both streams and sinks are built on channels. Most users shouldn't have to use channels directly, as streams and sinks are much more convenient and cover all common use cases. However, when adding new stream and sink operators, or doing something highly specialized, it may be useful to use channels directly.

Channels compose in a variety of ways:

  • Piping: One channel can be piped to another channel, assuming the input type of the second is the same as the output type of the first.
  • Sequencing: The terminal value of one channel can be used to create another channel, and both the first channel and the function that makes the second channel can be composed into a channel.
  • Concatenating: The output of one channel can be used to create other channels, which are all concatenated together. The first channel and the function that makes the other channels can be composed into a channel.

Signature

interface Channel<out OutElem, out OutErr = never, out OutDone = void, in InElem = unknown, in InErr = unknown, in InDone = unknown, out Env = never> extends Variance<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, Pipeable {
[ignoreSymbol]?: ChannelUnifyIgnore;
[typeSymbol]?: unknown;
[unifySymbol]?: ChannelUnify<Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>>;
}

Example Typing channels

import { Channel, Effect } from "effect"
// A channel that outputs numbers and requires no environment
type NumberChannel = Channel.Channel<number>
// A channel that outputs strings, can fail with Error, completes with boolean
type StringChannel = Channel.Channel<string, Error, boolean>
// A channel with all type parameters specified
type FullChannel = Channel.Channel<
string, // OutElem - output elements
Error, // OutErr - output errors
number, // OutDone - completion value
number, // InElem - input elements
string, // InErr - input errors
boolean, // InDone - input completion
{ db: string } // Env - required environment
>
const channel: NumberChannel = Channel.succeed(1)
Effect.runSync(Channel.runCollect(channel)) // => [1]

ChannelUnify

interface
Since v2.0.0

Type-level unification support for Channel values.

Details

This preserves all Channel type parameters when Unify normalizes unions or generic return types that include channels. Users normally do not need to reference this interface directly.

Signature

interface ChannelUnify<A extends {
[typeSymbol]?: any;
}> extends EffectUnify<A> {
Channel?: () => A[typeof typeSymbol] extends Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env> | _ ? Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env> : never;
}
Since v2.0.0

Marker used by Unify while resolving Channel values.

Details

It prevents the inherited Effect unifier from being selected when the channel-specific unifier should preserve Channel input, output, and environment type parameters. Users normally do not need to reference this interface directly.

Signature

interface ChannelUnifyIgnore {
Effect?: true;
}
Since v4.0.0

Represents strategies for halting merged channels when one completes or fails.

Signature

type HaltStrategy = "left" | "right" | "both" | "either"

Example Choosing merge halt strategies

import { Channel } from "effect"
// Different halt strategies for channel merging
const strategies: Array<Channel.HaltStrategy> = ["left", "right", "both", "either"] // => ["left", "right", "both", "either"]

Variance

interface
Since v2.0.0

Phantom variance marker for the type parameters of Channel.

Details

Output element, output error, output done, and environment types are covariant. Input element, input error, and input done types are contravariant. This is type-level machinery and is not used directly at runtime.

Signature

interface Variance<out OutElem, out OutErr, out OutDone, in InElem, in InErr, in InDone, out Env> {
readonly "~effect/Channel": VarianceStruct<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>;
}
Since v2.0.0

Structural encoding used by Variance to record each Channel type parameter's variance.

Details

The _OutElem, _OutErr, _OutDone, and _Env fields are covariant; the _InElem, _InErr, and _InDone fields are contravariant. Users normally do not need to reference this interface directly.

Signature

interface VarianceStruct<out OutElem, out OutErr, out OutDone, in InElem, in InErr, in InDone, out Env> {
_Env: Covariant<Env>;
_InDone: Contravariant<InDone>;
_InElem: Contravariant<InElem>;
_InErr: Contravariant<InErr>;
_OutDone: Covariant<OutDone>;
_OutElem: Covariant<OutElem>;
_OutErr: Covariant<OutErr>;
}

Other

Signature

declare const catch: {
<OutErr, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (d: OutErr) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1, OutDone1 | OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: OutErr) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Signature

declare const let: {
<N extends string, OutElem extends object, B>(name: Exclude<N, keyof OutElem>, f: (a: NoInfer<OutElem>) => B): <OutErr, OutDone, InElem, InErr, InDone, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, R>) => Channel<{ [K in string | number | symbol]: K extends keyof OutElem ? OutElem[K] : B }, OutErr, OutDone, InElem, InErr, InDone, R>;
<OutElem extends object, OutErr, OutDone, InElem, InErr, InDone, R, N extends string, B>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, R>, name: Exclude<N, keyof OutElem>, f: (a: NoInfer<OutElem>) => B): Channel<{ [K in string | number | symbol]: K extends keyof OutElem ? OutElem[K] : B }, OutErr, OutDone, InElem, InErr, InDone, R>;
}

Providing Services

Since v4.0.0

Provides a Layer or Context to the channel, removing the corresponding service requirements.

Details

Providing a Context delegates to provideContext. Providing a Layer builds the layer in the channel scope. Use options.local to build a fresh layer instance for this provision.

Signature

declare const provide: {
<A, E = never, R = never>(layer: Layer<A, E, R> | Context<A>, options?: {
readonly local?: boolean;
}): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone, InElem, InErr, InDone, R | Exclude<Env, A>>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E = never, R = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, layer: Layer<A, E, R> | Context<A>, options?: {
readonly local?: boolean;
}): Channel<OutElem, OutErr | E, OutDone, InElem, InErr, InDone, R | Exclude<Env, A>>;
}

Provides a Context to the channel, removing the corresponding service requirements from the returned channel.

Signature

declare const provideContext: {
<R2>(context: Context<R2>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Exclude<Env, R2>>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, R2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, context: Context<R2>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Exclude<Env, R2>>;
}

Provides a concrete service for a context key, removing that service requirement from the returned channel.

Signature

declare const provideService: {
<I, S>(key: Key<I, S>, service: NoInfer<S>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Exclude<Env, I>>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, I, S>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, key: Key<I, S>, service: NoInfer<S>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Exclude<Env, I>>;
}

Provides a service to the channel after obtaining it from an effect.

When to use

Use to supply a channel dependency when constructing the service itself is effectful or can fail.

Details

If the service effect fails, the returned channel fails. The provided service removes the corresponding service requirement from the returned channel.

Signature

declare const provideServiceEffect: {
<I, S, ES, RS>(key: Key<I, S>, service: Effect<NoInfer<S>, ES, RS>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, ES | OutErr, OutDone, InElem, InErr, InDone, RS | Exclude<Env, I>>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, I, S, ES, RS>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, key: Key<I, S>, service: Effect<NoInfer<S>, ES, RS>): Channel<OutElem, OutErr | ES, OutDone, InElem, InErr, InDone, RS | Exclude<Env, I>>;
}

Transforms the current context before running the channel.

Details

The function receives the surrounding context and returns the context to provide to the channel. The returned channel requires the services needed to build that context.

Signature

declare const updateContext: {
<Env, R2>(f: (context: Context<R2>) => Context<Env>): <OutElem, OutErr, OutDone, InElem, InErr, InDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R2>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, R2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (context: Context<R2>) => Context<Env>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R2>;
}

Updates a service in the current context before running the channel.

Details

The existing service is read from the context. The updated service is provided to the channel under the same key.

Signature

declare const updateService: {
<I, S>(key: Key<I, S>, f: (service: NoInfer<S>) => S): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, I | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, I, S>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, service: Key<I, S>, f: (service: NoInfer<S>) => S): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env | I>;
}

Repetition

Since v4.0.0

Repeats this channel forever.

Signature

declare function forever<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>): Channel<OutElem, OutErr, never, InElem, InErr, InDone, Env>
Since v4.0.0

Repeats this channel according to the provided schedule.

Signature

declare const repeat: {
<SO, OutDone, SE, SR>(schedule: Schedule<SO, NoInfer<OutDone>, SE, SR> | ($: <SO, SE, SR>(_: Schedule<SO, NoInfer<OutDone>, SE, SR>) => Schedule<SO, OutDone, SE, SR>) => Schedule<SO, NoInfer<OutDone>, SE, SR>): <OutElem, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, SE | OutErr, OutDone, InElem, InErr, InDone, SR | Env>) => Channel<OutElem, SE | OutErr, OutDone, InElem, InErr, InDone, SR | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, schedule: Schedule<SO, OutDone, SE, SR> | ($: <SO, SE, SR>(_: Schedule<SO, NoInfer<OutDone>, SE, SR>) => Schedule<SO, OutDone, SE, SR>) => Schedule<SO, NoInfer<OutDone>, SE, SR>): Channel<OutElem, OutErr | SE, OutDone, InElem, InErr, InDone, Env | SR>;
}

Resource Management

Since v2.0.0

Returns a channel with a finalizer effect that is guaranteed to run once the channel begins execution, whether it succeeds or fails.

Signature

declare const ensuring: {
<Env2>(finalizer: Effect<unknown, never, Env2>): <OutElem, OutDone, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, finalizer: Effect<unknown, never, Env2>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env | Env2>;
}

Example Ensuring cleanup runs

import { Channel, Data, Effect } from "effect"
class EnsureError extends Data.TaggedError("EnsureError")<{
readonly operation: string
}> {}
// Create a channel
const dataChannel = Channel.fromIterable([1, 2, 3])
// Ensure cleanup always runs
const events: Array<string> = []
const channelWithCleanup = Channel.ensuring(
dataChannel,
Effect.sync(() => events.push("cleanup"))
)
const observed = [await Effect.runPromise(Channel.runCollect(channelWithCleanup)), events] // => [[1, 2, 3], ["cleanup"]]
Since v4.0.0

Returns a channel with an exit-aware finalizer that is guaranteed to run once the channel begins execution, whether it succeeds or fails.

Signature

declare const onExit: {
<OutDone, OutErr, Env2>(finalizer: (e: Exit<OutDone, OutErr>) => Effect<unknown, never, Env2>): <OutElem, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, finalizer: (e: Exit<OutDone, OutErr>) => Effect<unknown, never, Env2>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env | Env2>;
}

Example Running exit finalizers

import { Channel, Data, Effect, Exit } from "effect"
class ExitError extends Data.TaggedError("ExitError")<{
readonly stage: string
}> {}
// Create a channel
const dataChannel = Channel.fromIterable([1, 2, 3])
// Attach exit handler
const exits: Array<Exit.Exit<void, ExitError>> = []
const channelWithExit = Channel.onExit(dataChannel, (exit) => {
exits.push(exit)
return Effect.void
})
const observed = [await Effect.runPromise(Channel.runCollect(channelWithExit)), exits] // => [[1, 2, 3], [Exit.void]]
Since v2.0.0

Runs a channel with a scope provided for the duration of the channel execution, removing the channel's Scope requirement.

Signature

declare function scoped<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Exclude<Env, Scope>>

Running

Concatenates a channel's Uint8Array chunks into a single Uint8Array.

Gotchas

This materializes the full content in memory. The source channel must not reuse or mutate emitted buffers, which are retained until collection completes.

Signature

declare function mkUint8Array<OutErr, OutDone, Env>(self: Channel<readonly [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>], OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<Uint8Array<ArrayBuffer>, OutErr, Env>

Example Joining channel byte chunks

import { Channel, Effect } from "effect"
const channel = Channel.fromArray([
[new Uint8Array([1, 2])],
[new Uint8Array([3, 4])]
] as const)
const bytes = Effect.runSync(Channel.mkUint8Array(channel))
Array.from(bytes) // => [1, 2, 3, 4]

Runs a channel and collects all output elements into an array.

Signature

declare function runCollect<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<Array<OutElem>, OutErr, Env>

Example Collecting channel output

import { Channel, Data, Effect } from "effect"
class CollectError extends Data.TaggedError("CollectError")<{
readonly reason: string
}> {}
// Create a channel with elements
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Collect all elements into an array
const collectEffect = Channel.runCollect(numbersChannel)
Effect.runSync(collectEffect) // => [1, 2, 3, 4, 5]
Since v4.0.0

Runs a channel and counts the number of elements it outputs.

Signature

declare function runCount<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<number, OutErr, Env>

Example Counting channel output

import { Channel, Data, Effect } from "effect"
class CountError extends Data.TaggedError("CountError")<{
readonly reason: string
}> {}
// Create a channel with multiple elements
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Count the elements
const countEffect = Channel.runCount(numbersChannel)
Effect.runSync(countEffect) // => 5
Since v2.0.0

Runs a channel and discards all output elements, returning only the final result.

Signature

declare function runDrain<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<OutDone, OutErr, Env>

Example Draining channel output at runtime

import { Channel, Data, Effect } from "effect"
class DrainError extends Data.TaggedError("DrainError")<{
readonly stage: string
}> {}
// Create a channel that outputs elements and completes with a result
const resultChannel = Channel.fromIterable([1, 2, 3])
const completedChannel = Channel.concat(resultChannel, Channel.end("completed"))
// Drain all elements and get only the final result
const drainEffect = Channel.runDrain(completedChannel)
Effect.runSync(drainEffect) // => "completed"
Since v4.0.0

Runs a channel and folds over all output elements with an accumulator.

Signature

declare const runFold: {
<Z, OutElem>(initial: LazyArg<Z>, f: (acc: Z, o: OutElem) => Z): <OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<Z, OutErr, Env>;
<OutElem, OutErr, OutDone, Env, Z>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, initial: LazyArg<Z>, f: (acc: Z, o: OutElem) => Z): Effect<Z, OutErr, Env>;
}

Example Folding channel output

import { Channel, Data, Effect } from "effect"
class FoldError extends Data.TaggedError("FoldError")<{
readonly operation: string
}> {}
// Create a channel with numbers
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Fold to calculate sum
const sumEffect = Channel.runFold(numbersChannel, () => 0, (acc, n) => acc + n)
Effect.runSync(sumEffect) // => 15

Runs a channel and effectfully folds all output elements with an accumulator.

When to use

Use when folding channel output needs effects, services, or an additional failure channel during accumulation.

Details

The initial accumulator is evaluated lazily. Each output element is passed to the effectful accumulator function. The returned effect succeeds with the final accumulator value.

Signature

declare const runFoldEffect: {
<OutElem, Z, E, R>(initial: LazyArg<Z>, f: (acc: Z, o: OutElem) => Effect<Z, E, R>): <OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<Z, E | OutErr, R | Env>;
<OutElem, OutErr, OutDone, Env, Z, E, R>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, initial: LazyArg<Z>, f: (acc: Z, o: OutElem) => Effect<Z, E, R>): Effect<Z, OutErr | E, Env | R>;
}

Runs a channel and applies an effect to each output element.

Signature

declare const runForEach: {
<OutElem, EX, RX>(f: (o: OutElem) => Effect<void, EX, RX>): <OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<OutDone, EX | OutErr, RX | Env>;
<OutElem, OutErr, OutDone, Env, EX, RX>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, f: (o: OutElem) => Effect<void, EX, RX>): Effect<OutDone, OutErr | EX, Env | RX>;
}

Example Running effects for each output

import { Channel, Data, Effect } from "effect"
class ForEachError extends Data.TaggedError("ForEachError")<{
readonly element: unknown
}> {}
// Create a channel with numbers
const numbersChannel = Channel.fromIterable([1, 2, 3])
// Run forEach to process each element
const processed: Array<number> = []
const forEachEffect = Channel.runForEach(
numbersChannel,
(n) => Effect.sync(() => processed.push(n))
)
await Effect.runPromise(forEachEffect)
processed // => [1, 2, 3]

Runs a channel and applies an effectful predicate to each output element until the predicate returns false.

Details

Returning true continues consuming the channel. Returning false stops consumption early. The returned effect completes with void.

Signature

declare const runForEachWhile: {
<OutElem, EX, RX>(f: (o: OutElem) => Effect<boolean, EX, RX>): <OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Effect<void, EX | OutErr, RX | Env>;
<OutElem, OutErr, OutDone, Env, EX, RX>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, f: (o: OutElem) => Effect<boolean, EX, RX>): Effect<void, OutErr | EX, Env | RX>;
}
Since v4.0.0

Runs a channel until the first output element is available, returning it in an Option.

Details

Returns Option.some with the first output element, or Option.none if the channel completes without emitting output.

Signature

declare function runHead<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<Option<OutElem>, OutErr, Env>
Since v4.0.0

Runs a channel to completion and returns the last output element in an Option.

Details

Returns Option.some with the last emitted element, or Option.none if the channel completes without emitting output.

Signature

declare function runLast<OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>): Effect<Option<OutElem>, OutErr, Env>

Sequencing

Since v4.0.0

Adds a field to each object emitted by a channel by running another channel derived from that object.

Details

The field name must not already exist on the emitted object. The derived channel's output becomes the value of the new field. options.concurrency and options.bufferSize control how derived channels are flattened.

Signature

declare const bind: {
<N extends string, OutElem extends object, B, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>(name: Exclude<N, keyof OutElem>, f: (a: NoInfer<OutElem>) => Channel<B, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<{ [K in string | number | symbol]: K extends keyof OutElem ? OutElem[K] : B }, OutErr2 | OutErr, OutDone, InElem & InElem2, InErr & InErr2, InDone & InDone2, Env2 | Env>;
<OutElem extends object, OutErr, OutDone, InElem, InErr, InDone, Env, N extends string, B, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, name: Exclude<N, keyof OutElem>, f: (a: NoInfer<OutElem>) => Channel<B, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): Channel<{ [K in string | number | symbol]: K extends keyof OutElem ? OutElem[K] : B }, OutErr | OutErr2, OutDone, InElem & InElem2, InErr & InErr2, InDone & InDone2, Env | Env2>;
}
Since v4.0.0

Combines two channels with a stateful pull function.

When to use

Use to coordinate pulling from two channels when each output element depends on both sides and local state.

Details

The combining function receives the current state and pull functions for the left and right channels. It returns the next output element together with the next state.

Signature

declare const combine: {
<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2, S, OutElem, OutErr, OutDone, A, E, R>(that: Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>, s: LazyArg<S>, f: (s: S, pullLeft: Pull<OutElem, OutErr, OutDone>, pullRight: Pull<OutElem2, OutErr2, OutDone2>) => Effect<readonly [A, S], E, R>): <InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<A, Exclude<E, Done<any>>, Extract<E>, InElem & InElem2, InErr & InErr2, InDone & InDone2, Env2 | R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2, S, A, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, that: Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>, s: LazyArg<S>, f: (s: S, pullLeft: Pull<OutElem, OutErr, OutDone>, pullRight: Pull<OutElem2, OutErr2, OutDone2>) => Effect<readonly [A, S], E, R>): Channel<A, Exclude<E, Done<any>>, Extract<E>, InElem & InElem2, InErr & InErr2, InDone & InDone2, Env | Env2 | R>;
}
Since v4.0.0

Concatenates this channel with another channel, so that the second channel starts emitting values after the first channel has completed.

Signature

declare const concat: {
<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(that: Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | OutErr, OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, that: Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Concatenating channels

import { Channel, Data, Effect } from "effect"
class ConcatError extends Data.TaggedError("ConcatError")<{
readonly reason: string
}> {}
// Create two channels
const firstChannel = Channel.fromIterable([1, 2, 3])
const secondChannel = Channel.fromIterable(["a", "b", "c"])
// Concatenate them
const concatenatedChannel = Channel.concat(firstChannel, secondChannel)
Effect.runSync(Channel.runCollect(concatenatedChannel)) // => [1, 2, 3, "a", "b", "c"]

Concatenates this channel with another channel created from the terminal value of this channel. The new channel is created using the provided function.

Signature

declare const concatWith: {
<OutDone, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (leftover: NoInfer<OutDone>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | OutErr, OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (leftover: NoInfer<OutDone>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Concatenating with completion values

import { Channel, Data, Effect } from "effect"
class ConcatError extends Data.TaggedError("ConcatError")<{
readonly reason: string
}> {}
// Create a channel that outputs numbers and terminates with sum
const numberChannel = Channel.fromIterable([1, 2, 3]).pipe(
Channel.concatWith((sum: void) => Channel.succeed(`Completed processing`))
)
Effect.runSync(Channel.runCollect(numberChannel)) // => [1, 2, 3, "Completed processing"]

Runs an input handler against the upstream pull while the wrapped channel runs without receiving upstream input directly.

Details

The input handler is forked in the channel scope. The wrapped channel is run with an already-completed input.

Signature

declare const embedInput: {
<InElem, InErr, InDone, R>(input: (upstream: Pull<InElem, InErr, InDone>) => Effect<void, never, R>): <OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, Env, InErr, InElem, InDone, R>(self: Channel<OutElem, OutErr, OutDone, unknown, unknown, unknown, Env>, input: (upstream: Pull<InElem, InErr, InDone>) => Effect<void, never, R>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env | R>;
}

Example Embedding custom input handling

import { Channel, Effect } from "effect"
// Create a base channel
const baseChannel = Channel.fromIterable([1, 2, 3])
// Drain the embedded input while the base channel runs
const embeddedChannel = Channel.embedInput(
baseChannel,
(upstream) =>
upstream.pipe(
Effect.forever,
Effect.ignore
)
)
await Effect.runPromise(Channel.runCollect(embeddedChannel)) // => [1, 2, 3]
Since v2.0.0

Maps each output element to a channel and flattens the child channel outputs.

Details

The source channel's done value is preserved. Child channel done values are used only for child-channel completion. By default child channels are run sequentially. Use options.concurrency and options.bufferSize to run child channels concurrently.

Signature

declare const flatMap: {
<OutElem, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (d: OutElem) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1, OutErr1 | OutErr, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: OutElem) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): Channel<OutElem1, OutErr | OutErr1, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Flat mapping channel output

import { Channel, Data, Effect } from "effect"
class ProcessError extends Data.TaggedError("ProcessError")<{
readonly cause: string
}> {}
// Create a channel that outputs numbers
const numberChannel = Channel.fromIterable([1, 2, 3])
// FlatMap each number to create new channels
const flatMappedChannel = Channel.flatMap(
numberChannel,
(n) =>
Channel.fromIterable(Array.from({ length: n }, (_, i) => `item-${n}-${i}`))
)
Effect.runSync(Channel.runCollect(flatMappedChannel)) // => ["item-1-0", "item-2-0", "item-2-1", "item-3-0", "item-3-1", "item-3-2"]
Since v2.0.0

Maps the output of this channel using the specified function.

Signature

declare const map: {
<OutElem, OutElem2>(f: (o: OutElem, i: number) => OutElem2): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem2, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (o: OutElem, i: number) => OutElem2): Channel<OutElem2, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Example Mapping channel output

import { Channel, Data, Effect } from "effect"
class TransformError extends Data.TaggedError("TransformError")<{
readonly reason: string
}> {}
// Basic mapping of channel values
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
const doubledChannel = Channel.map(numbersChannel, (n) => n * 2)
Effect.runSync(Channel.runCollect(doubledChannel)) // => [2, 4, 6, 8, 10]
// Transform string data
const wordsChannel = Channel.fromIterable(["hello", "world", "effect"])
const upperCaseChannel = Channel.map(wordsChannel, (word) => word.toUpperCase())
Effect.runSync(Channel.runCollect(upperCaseChannel)) // => ["HELLO", "WORLD", "EFFECT"]
// Complex object transformation
type User = { id: number; name: string }
type UserDisplay = { displayName: string; isActive: boolean }
const usersChannel = Channel.fromIterable([
{ id: 1, name: "Alice" },
{ id: 2, name: "Bob" }
])
const displayChannel = Channel.map(usersChannel, (user): UserDisplay => ({
displayName: `User: ${user.name}`,
isActive: true
}))
Effect.runSync(Channel.runCollect(displayChannel)) // => [{ displayName: "User: Alice", isActive: true }, { displayName: "User: Bob", isActive: true }]
Since v4.0.0

Maps over a channel statefully with an accumulator, where each element can produce multiple output values.

Signature

declare const mapAccum: {
<S, OutElem, B, E = never, R = never>(initial: LazyArg<S>, f: (s: S, a: NoInfer<OutElem>) => Effect<readonly [S, readonly Array<B>], E, R> | readonly [S, readonly Array<B>], options?: {
readonly onHalt?: (state: S) => Array<B>;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<B, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, S, B, E = never, R = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, initial: LazyArg<S>, f: (s: S, a: NoInfer<OutElem>) => Effect<readonly [S, readonly Array<B>], E, R> | readonly [S, readonly Array<B>], options?: {
readonly onHalt?: (state: S) => Array<B>;
}): Channel<B, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Example Mapping with accumulated state

import { Channel, Effect } from "effect"
// Create a channel with numbers
const numbersChannel = Channel.fromIterable([1, 2, 3, 4])
// Use mapAccum to create running sums and emit both current and sum
const runningSum = Channel.mapAccum(
numbersChannel,
() => 0, // initial accumulator state
(sum, current) => {
const newSum = sum + current
// Return [newState, outputValues]
return [newSum, [current, newSum]] as const
}
)
// Using with Effect for async processing
const asyncMapAccum = Channel.mapAccum(
numbersChannel,
() => "",
(acc, value) =>
Effect.gen(function*() {
const newAcc = acc + value.toString()
return [newAcc, [`${value}-processed`, newAcc]] as const
})
)
Effect.runSync(Channel.runCollect(runningSum)) // => [1, 1, 2, 3, 3, 6, 4, 10]
Effect.runSync(Channel.runCollect(asyncMapAccum)) // => ["1-processed", "1", "2-processed", "12", "3-processed", "123", "4-processed", "1234"]
Since v4.0.0

Maps the done value of this channel using the specified function.

Signature

declare const mapDone: {
<OutDone, OutDone2>(f: (o: OutDone) => OutDone2): <OutElem, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone2, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (o: OutDone) => OutDone2): Channel<OutElem, OutErr, OutDone2, InElem, InErr, InDone, Env>;
}

Maps the done value of this channel using the specified effectful function.

When to use

Use when the terminal done value transformation needs services or can fail, while emitted elements should pass through unchanged.

Signature

declare const mapDoneEffect: {
<OutDone, OutDone2, E, R>(f: (o: OutDone) => Effect<OutDone2, E, R>): <OutElem, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, E | OutErr, OutDone2, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (o: OutDone) => Effect<OutDone2, E, R>): Channel<OutElem, OutErr | E, OutDone2, InElem, InErr, InDone, Env | R>;
}

Maps each output element with an effectful function, preserving the source channel's done value.

When to use

Use when transforming each channel output needs an Effect, service dependency, failure channel, or configured concurrency.

Details

The mapping function receives the output element and its zero-based index. By default elements are mapped sequentially. Use options.concurrency to map multiple elements concurrently, and options.unordered to allow concurrently mapped outputs to be emitted as soon as they complete.

Signature

declare const mapEffect: {
<OutElem, OutElem1, OutErr1, Env1>(f: (d: OutElem, i: number) => Effect<OutElem1, OutErr1, Env1>, options?: {
readonly concurrency?: Types.Concurrency;
readonly unordered?: boolean;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1, OutErr1 | OutErr, OutDone, InElem, InErr, InDone, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: OutElem, i: number) => Effect<OutElem1, OutErr1, Env1>, options?: {
readonly concurrency?: Types.Concurrency;
readonly unordered?: boolean;
}): Channel<OutElem1, OutErr | OutErr1, OutDone, InElem, InErr, InDone, Env | Env1>;
}

Example Mapping channel output with effects

import { Channel, Effect } from "effect"
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
const processedChannel = Channel.mapEffect(
numbersChannel,
(n) => Effect.succeed(n * n)
)
await Effect.runPromise(Channel.runCollect(processedChannel)) // => [1, 4, 9, 16, 25]
Since v2.0.0

Returns a new channel which is the same as this one but applies the given function to the input channelโ€™s input elements.

Signature

declare const mapInput: {
<InElem, InElem2, InErr, R = never>(f: (i: InElem2) => Effect<InElem, InErr, R>): <OutElem, OutErr, OutDone, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr, OutDone, InElem2, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, InElem2, R = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (i: InElem2) => Effect<InElem, InErr, R>): Channel<OutElem, OutErr, OutDone, InElem2, InErr, InDone, Env | R>;
}

Returns a new channel which is the same as this one but applies the given function to the input errors.

Signature

declare const mapInputError: {
<InErr, InErr2, R = never>(f: (i: InErr2) => Effect<InErr, InErr, R>): <OutElem, OutErr, OutDone, InElem, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, R | Env>) => Channel<OutElem, OutErr, OutDone, InElem, InErr2, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, InErr2, R = never>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (i: InErr2) => Effect<InErr, InErr, R>): Channel<OutElem, OutErr, OutDone, InElem, InErr2, InDone, Env | R>;
}

Runs a fallback channel if this channel completes without emitting any output elements.

Details

If the source emits at least one element, the source is used unchanged. If the source completes before emitting an element, the fallback function receives the source done value and returns the replacement channel.

Signature

declare const orElseIfEmpty: {
<OutDone, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (leftover: NoInfer<OutDone>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): <OutElem, OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1 | OutElem, OutErr1 | OutErr, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (leftover: NoInfer<OutDone>) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>): Channel<OutElem | OutElem1, OutErr | OutErr1, OutDone | OutDone1, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}
Since v2.0.0

Returns a new channel that pipes the output of this channel into the specified channel. The returned channel has the input type of this channel, and the output type of the specified channel, terminating with the value of the specified channel.

Signature

declare const pipeTo: {
<OutElem2, OutErr2, OutDone2, OutElem, OutErr, OutDone, Env2>(that: Channel<OutElem2, OutErr2, OutDone2, OutElem, OutErr, OutDone, Env2>): <InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem2, OutErr2, OutDone2, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, that: Channel<OutElem2, OutErr2, OutDone2, OutElem, OutErr, OutDone, Env2>): Channel<OutElem2, OutErr2, OutDone2, InElem, InErr, InDone, Env | Env2>;
}

Example Piping one channel into another

import { Channel, Data, Effect } from "effect"
class PipeError extends Data.TaggedError("PipeError")<{
readonly stage: string
}> {}
// Create source and transform channels
const sourceChannel = Channel.fromIterable([1, 2, 3])
const transformChannel = Channel.map(sourceChannel, (n: number) => n * 2)
// Pipe the source into the transform
const pipedChannel = Channel.pipeTo(sourceChannel, transformChannel)
Effect.runSync(Channel.runCollect(pipedChannel)) // => [2, 4, 6]

Returns a new channel that pipes the output of this channel into the specified channel and preserves this channel's failures without providing them to the other channel for observation.

Signature

declare const pipeToOrFail: {
<OutElem2, OutErr2, OutDone2, OutElem, OutDone, Env2>(that: Channel<OutElem2, OutErr2, OutDone2, OutElem, never, OutDone, Env2>): <OutErr, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem2, OutErr2 | OutErr, OutDone2, InElem, InErr, InDone, Env2 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, that: Channel<OutElem2, OutErr2, OutDone2, OutElem, never, OutDone, Env2>): Channel<OutElem2, OutErr | OutErr2, OutDone2, InElem, InErr, InDone, Env | Env2>;
}

Example Piping while preserving failures

import { Channel, Data, Effect, Exit } from "effect"
class SourceError extends Data.TaggedError("SourceError")<{
readonly code: number
}> {}
// Create a failing source channel
const error = new SourceError({ code: 404 })
const failingSource = Channel.fail(error)
const safeTransform = Channel.identity<never, never, never>()
// Pipe while preserving source failures
const safePipedChannel = Channel.pipeToOrFail(failingSource, safeTransform)
Effect.runSync(Effect.exit(Channel.runCollect(safePipedChannel))) // => Exit.fail(error)
Since v4.0.0

Transforms a channel statefully by scanning over its output with an accumulator function. Emits the intermediate results of the scan operation.

Signature

declare const scan: {
<S, OutElem>(initial: S, f: (s: S, a: NoInfer<OutElem>) => S): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<S, OutErr, OutDone, InElem, InErr, InDone, Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, S>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, initial: S, f: (s: S, a: NoInfer<OutElem>) => S): Channel<S, OutErr, OutDone, InElem, InErr, InDone, Env>;
}

Example Scanning channel output

import { Channel, Effect } from "effect"
// Create a channel with numbers
const numbersChannel = Channel.fromIterable([1, 2, 3, 4, 5])
// Scan to create running sum
const runningSumChannel = Channel.scan(numbersChannel, 0, (sum, n) => sum + n)
Effect.runSync(Channel.runCollect(runningSumChannel)) // => [0, 1, 3, 6, 10, 15]
// Note: emits the initial value and each intermediate result
// Scan with string concatenation
const wordsChannel = Channel.fromIterable(["hello", "world", "from", "effect"])
const sentenceChannel = Channel.scan(
wordsChannel,
"",
(sentence, word) => sentence === "" ? word : `${sentence} ${word}`
)
Effect.runSync(Channel.runCollect(sentenceChannel)) // => ["", "hello", "hello world", "hello world from", "hello world from effect"]

Transforms a channel statefully by scanning over its output with an effectful accumulator function. Emits the intermediate results of the scan operation.

When to use

Use when maintaining accumulated state over channel output requires Effects or can fail, while still emitting each intermediate state.

Signature

declare const scanEffect: {
<S, OutElem, E, R>(initial: S, f: (s: S, a: NoInfer<OutElem>) => Effect<S, E, R>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<S, E | OutErr, OutDone, InElem, InErr, InDone, R | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, S, E, R>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, initial: S, f: (s: S, a: NoInfer<OutElem>) => Effect<S, E, R>): Channel<S, OutErr | E, OutDone, InElem, InErr, InDone, Env | R>;
}

Example Scanning channel output with effects

import { Channel, Data, Effect } from "effect"
class ScanError extends Data.TaggedError("ScanError")<{
readonly reason: string
}> {}
// Create a channel with numbers
const numbersChannel = Channel.fromIterable([1, 2, 3, 4])
// Effectful scan with async operations
const asyncScanChannel = Channel.scanEffect(
numbersChannel,
"",
(acc, value) =>
Effect.gen(function*() {
return acc + value.toString()
})
)
await Effect.runPromise(Channel.runCollect(asyncScanChannel)) // => ["", "1", "12", "123", "1234"]
// Scan with error handling
const errorHandlingScan = Channel.scanEffect(
numbersChannel,
0,
(sum, n) => {
if (n < 0) {
return Effect.fail(new ScanError({ reason: "negative number" }))
}
return Effect.succeed(sum + n)
}
)
await Effect.runPromise(Channel.runCollect(errorHandlingScan)) // => [0, 1, 3, 6, 10]
Since v4.0.0

Runs a schedule step for each output element while preserving the emitted elements.

Details

The schedule receives each output element as input. Schedule delays are applied between emitted elements. If the schedule fails, the returned channel fails. If the schedule finishes, the returned channel completes with the schedule output.

Signature

declare const schedule: {
<SO, OutElem, SE, SR>(schedule: Schedule<SO, NoInfer<OutElem>, SE, SR>): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, SE | OutErr, OutDone, InElem, InErr, InDone, SR | Env>) => Channel<OutElem, SE | OutErr, SO | OutDone, InElem, InErr, InDone, SR | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, schedule: Schedule<SO, OutElem, SE, SR>): Channel<OutElem, OutErr | SE, OutDone | SO, InElem, InErr, InDone, Env | SR>;
}

Maps each output element to a channel and emits values from the most recent active child channels.

Details

With the default concurrency of 1, starting a new child channel interrupts the previous child channel. Use options.concurrency to allow more active child channels. The source channel's done value is preserved.

Signature

declare const switchMap: {
<OutElem, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(f: (d: OutElem) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem1, OutErr1 | OutErr, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: OutElem) => Channel<OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>, options?: {
readonly bufferSize?: number;
readonly concurrency?: Types.Concurrency;
}): Channel<OutElem1, OutErr | OutErr1, OutDone, InElem & InElem1, InErr & InErr1, InDone & InDone1, Env | Env1>;
}

Example Switching mapped channels

import { Channel, Data, Effect } from "effect"
class SwitchError extends Data.TaggedError("SwitchError")<{
readonly reason: string
}> {}
// Create a channel that outputs numbers
const numberChannel = Channel.fromIterable([1, 2, 3])
// Switch to new channels based on each value
const switchedChannel = Channel.switchMap(
numberChannel,
(n) => Channel.fromIterable([`value-${n}`])
)
await Effect.runPromise(Channel.runCollect(switchedChannel)) // => ["value-3"]
Since v4.0.0

Applies a side effect function to each output element of the channel, returning a new channel that emits the same elements.

Details

The tap function allows you to perform side effects (like logging or debugging) on each element emitted by a channel without modifying the elements themselves.

Signature

declare const tap: {
<OutElem, X, OutErr1, Env1>(f: (d: NoInfer<OutElem>) => Effect<X, OutErr1, Env1>, options?: {
readonly concurrency?: Types.Concurrency;
}): <OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<OutElem, OutErr1 | OutErr, OutDone, InElem, InErr, InDone, Env1 | Env>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, X, OutErr1, Env1>(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>, f: (d: NoInfer<OutElem>) => Effect<X, OutErr1, Env1>, options?: {
readonly concurrency?: Types.Concurrency;
}): Channel<OutElem, OutErr | OutErr1, OutDone, InElem, InErr, InDone, Env | Env1>;
}

Example Tapping channel output

import { Channel, Data, Effect } from "effect"
class LogError extends Data.TaggedError("LogError")<{
readonly message: string
}> {}
// Create a channel that outputs numbers
const numberChannel = Channel.fromIterable([1, 2, 3])
// Tap into each output element to perform side effects
const processed: Array<number> = []
const tappedChannel = Channel.tap(
numberChannel,
(n) => Effect.sync(() => processed.push(n))
)
const observed = [await Effect.runPromise(Channel.runCollect(tappedChannel)), processed] // => [[1, 2, 3], [1, 2, 3]]

Splitting

Splits upstream string chunks into lines, recognizing \n, \r\n, and standalone \r as line terminators. The behavior matches String.linesIterator regardless of how the input is chunked.

Details

A line terminator at the very end of the stream does not produce a trailing empty line (consistent with String.linesIterator). Conversely, if the stream ends without a terminator the final partial line is still emitted.

Signature

declare function splitLines<Err, Done>(): Channel<readonly [string, string], Err, Done, readonly [string, string], Err, Done>

Example Splitting string chunks into lines

import { Effect, Stream } from "effect"
const result = await Effect.runPromise(Stream.runCollect(
Stream.splitLines(Stream.make("hel", "lo\r\nwor", "ld\n"))
))
result // => ["hello", "world"]

Tracing

Since v2.0.0

Runs the channel inside a tracing span with the specified name and options.

Details

The created span is provided as the current parent span while the channel runs. The span is ended with the channel's exit value.

Signature

declare const withSpan: {
(name: string, options?: SpanOptions): <OutElem, OutErr, OutDone, InElem, InErr, InDone, R>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<R, ParentSpan>>;
<OutElem, OutErr, OutDone, InElem, InErr, InDone, R>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R>, name: string, options?: SpanOptions): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<R, ParentSpan>>;
}

Transforming

Flattens a channel that outputs arrays into a channel that outputs individual elements.

Signature

declare function flattenArray<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(self: Channel<readonly Array<OutElem>, OutErr, OutDone, InElem, InErr, InDone, Env>): Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>

Example Flattening arrays of channel output

import { Channel, Data, Effect } from "effect"
class FlattenError extends Data.TaggedError("FlattenError")<{
readonly message: string
}> {}
// Create a channel that outputs arrays
const arrayChannel = Channel.fromIterable([
[1, 2, 3],
[4, 5],
[6, 7, 8, 9]
])
// Flatten the arrays into individual elements
const flattenedChannel = Channel.flattenArray(arrayChannel)
Effect.runSync(Channel.runCollect(flattenedChannel)) // => [1, 2, 3, 4, 5, 6, 7, 8, 9]

Flattens a channel that emits Take values into a channel that emits the Take outputs directly.

Details

Output Take values are emitted as non-empty arrays. Failed Take values fail the returned channel. Done Take values complete the returned channel.

Signature

declare function flattenTake<OutElem, OutErr, OutDone, OutErr2, OutDone2, InElem, InErr, InDone, Env>(self: Channel<Take<OutElem, OutErr, OutDone>, OutErr2, OutDone2, InElem, InErr, InDone, Env>): Channel<readonly [OutElem, OutElem], OutErr | OutErr2, OutDone, InElem, InErr, InDone, Env>

Type IDs

Since v4.0.0

Runtime identifier stored on Channel values and used by isChannel to recognize them.

Signature

declare const TypeId: "~effect/Channel"
Since v4.0.0

String literal type used as the unique brand for Channel values.

Signature

type TypeId = "~effect/Channel"