<A>(pubsub: PubSub.PubSub<A>): Channel<Arr.NonEmptyReadonlyArray<A>>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.
Example (Batching PubSub values)
import { Channel, Data, Effect, PubSub } from "effect"
class BatchError extends Data.TaggedError("BatchError")<{
readonly message: string
}> {}
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.bounded<number>(16)
// 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
})Example (Processing PubSub orders in batches)
import { Channel, Effect, 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.bounded<Order>(100)
// 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
}
})
return processedChannel
})Example (Processing PubSub logs in batches)
import { Channel, Effect, 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.bounded<LogEntry>(500)
// 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))]
}
})
return analysisChannel
})export const const fromPubSubArray: <A>(
pubsub: PubSub.PubSub<A>
) => Channel<Arr.NonEmptyReadonlyArray<A>>
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.
Example (Batching PubSub values)
import { Channel, Data, Effect, PubSub } from "effect"
class BatchError extends Data.TaggedError("BatchError")<{
readonly message: string
}> {}
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.bounded<number>(16)
// 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
})
Example (Processing PubSub orders in batches)
import { Channel, Effect, 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.bounded<Order>(100)
// 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
}
})
return processedChannel
})
Example (Processing PubSub logs in batches)
import { Channel, Effect, 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.bounded<LogEntry>(500)
// 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))]
}
})
return analysisChannel
})
fromPubSubArray = <function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>): Channel<Arr.NonEmptyReadonlyArray<A>>A>(pubsub: PubSub.PubSub<A>(parameter) pubsub: {
pubsub: PubSub.Atomic<A>;
subscribers: PubSub.Subscribers<A>;
scope: Scope.Closeable;
shutdownHook: Latch.Latch;
shutdownFlag: MutableRef.MutableRef<boolean>;
strategy: PubSub.Strategy<A>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
pubsub: import PubSubPubSub.interface PubSub<in out A>A PubSub<A> is an asynchronous message hub into which publishers can publish
messages of type A and subscribers can subscribe to take messages of type
A.
Example (Publishing and subscribing to messages)
import { Effect, PubSub } from "effect"
const program = Effect.gen(function*() {
// Create a bounded PubSub with capacity 10
const pubsub = yield* PubSub.bounded<string>(10)
// Subscribe and consume messages
yield* Effect.scoped(Effect.gen(function*() {
const subscription = yield* PubSub.subscribe(pubsub)
// Publish messages
yield* PubSub.publish(pubsub, "Hello")
yield* PubSub.publish(pubsub, "World")
const message1 = yield* PubSub.take(subscription)
const message2 = yield* PubSub.take(subscription)
console.log(message1, message2) // "Hello", "World"
}))
})
Companion namespace containing the low-level building blocks used by
PubSub, including atomic implementations, backing subscriptions, replay
windows, and delivery strategies.
PubSub<function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>): Channel<Arr.NonEmptyReadonlyArray<A>>A>): interface Channel<out OutElem, out OutErr = never, out OutDone = void, in InElem = unknown, in InErr = unknown, in InDone = unknown, out Env = never>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.
Example (Typing channels)
import type { Channel } 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
>
Channel<import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>): Channel<Arr.NonEmptyReadonlyArray<A>>A>> =>
const unwrap: <
OutElem,
OutErr,
OutDone,
InElem,
InErr,
InDone,
R2,
E,
R
>(
channel: Effect.Effect<
Channel<
OutElem,
OutErr,
OutDone,
InElem,
InErr,
InDone,
R2
>,
E,
R
>
) => Channel<
OutElem,
E | OutErr,
OutDone,
InElem,
InErr,
InDone,
Exclude<R, Scope.Scope> | R2
>
Constructs a Channel from a scoped effect that will result in a
Channel if successful.
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)
// The resulting channel outputs: 1, 2, 3
unwrap(import EffectEffect.const map: {
<A, B>(f: (a: A) => B): <E, R>(
self: Effect<A, E, R>
) => Effect<B, E, R>
<A, E, R, B>(
self: Effect<A, E, R>,
f: (a: A) => B
): Effect<B, E, R>
}
map(import PubSubPubSub.const subscribe: <A>(
self: PubSub<A>
) => Effect.Effect<
Subscription<A>,
never,
Scope.Scope
>
Subscribes to receive messages from the PubSub. The resulting subscription can
be evaluated multiple times within the scope to take a message from the PubSub
each time.
Example (Subscribing to messages)
import { Effect, PubSub } from "effect"
const program = Effect.gen(function*() {
const pubsub = yield* PubSub.bounded<string>(10)
// Subscribe within a scope for automatic cleanup
yield* Effect.scoped(Effect.gen(function*() {
const subscription = yield* PubSub.subscribe(pubsub)
// Publish some messages
yield* PubSub.publish(pubsub, "Hello")
yield* PubSub.publish(pubsub, "World")
// Take messages one by one
const msg1 = yield* PubSub.take(subscription)
const msg2 = yield* PubSub.take(subscription)
console.log(msg1, msg2) // "Hello", "World"
// Subscription is automatically cleaned up when scope exits
}))
yield* Effect.scoped(Effect.gen(function*() {
const sub1 = yield* PubSub.subscribe(pubsub)
const sub2 = yield* PubSub.subscribe(pubsub)
// Multiple subscribers can receive the same messages
yield* PubSub.publish(pubsub, "Broadcast")
const [msg1, msg2] = yield* Effect.all([
PubSub.take(sub1),
PubSub.take(sub2)
])
console.log("Both received:", msg1, msg2) // "Broadcast", "Broadcast"
}))
})
subscribe(pubsub: PubSub.PubSub<A>(parameter) pubsub: {
pubsub: PubSub.Atomic<A>;
subscribers: PubSub.Subscribers<A>;
scope: Scope.Closeable;
shutdownHook: Latch.Latch;
shutdownFlag: MutableRef.MutableRef<boolean>;
strategy: PubSub.Strategy<A>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
pubsub), const fromSubscriptionArray: <A>(
subscription: PubSub.Subscription<A>
) => Channel<Arr.NonEmptyReadonlyArray<A>>
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.
Example (Batching subscription values)
import { Channel, Data, Effect, 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
})
Example (Processing subscription values in batches)
import { Channel, Data, Effect, 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) => {
console.log(`Processing batch of ${batch.length} items:`, batch)
return batch.map((item) => item.toUpperCase())
})
return processedChannel
})
Example (Aggregating subscription metrics)
import { Channel, Effect, 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))
}
})
return aggregatedChannel
})
fromSubscriptionArray))