<A>(
pubsub: PubSub.PubSub<A>,
options?: { readonly shutdownOnEnd?: boolean | undefined } | undefined
): <E, R>(self: Stream<A, E, R>) => Effect.Effect<void, E, R>
<A, E, R>(
self: Stream<A, E, R>,
pubsub: PubSub.PubSub<A>,
options?: { readonly shutdownOnEnd?: boolean | undefined } | undefined
): Effect.Effect<void, never, R>Runs the stream, publishing elements into the provided PubSub.
Details
shutdownOnEnd controls whether the PubSub is shut down when the stream ends.
It only shuts down when set to true.
Example (Running a stream into a PubSub)
import { Console, Effect, PubSub, Stream } from "effect"
const program = Effect.scoped(Effect.gen(function* () {
const pubsub = yield* PubSub.unbounded<number>()
const subscription = yield* PubSub.subscribe(pubsub)
yield* Stream.runIntoPubSub(Stream.fromIterable([1, 2]), pubsub)
const first = yield* PubSub.take(subscription)
const second = yield* PubSub.take(subscription)
yield* Console.log(first)
yield* Console.log(second)
}))
Effect.runPromise(program)
//=> 1
//=> 2destructors
Source effect/Stream.ts:1147121 lines
export const const runIntoPubSub: {
<A>(
pubsub: PubSub.PubSub<A>,
options?:
| {
readonly shutdownOnEnd?:
| boolean
| undefined
}
| undefined
): <E, R>(
self: Stream<A, E, R>
) => Effect.Effect<void, E, R>
<A, E, R>(
self: Stream<A, E, R>,
pubsub: PubSub.PubSub<A>,
options?:
| {
readonly shutdownOnEnd?:
| boolean
| undefined
}
| undefined
): Effect.Effect<void, never, R>
}
Runs the stream, publishing elements into the provided PubSub.
Details
shutdownOnEnd controls whether the PubSub is shut down when the stream ends.
It only shuts down when set to true.
Example (Running a stream into a PubSub)
import { Console, Effect, PubSub, Stream } from "effect"
const program = Effect.scoped(Effect.gen(function* () {
const pubsub = yield* PubSub.unbounded<number>()
const subscription = yield* PubSub.subscribe(pubsub)
yield* Stream.runIntoPubSub(Stream.fromIterable([1, 2]), pubsub)
const first = yield* PubSub.take(subscription)
const second = yield* PubSub.take(subscription)
yield* Console.log(first)
yield* Console.log(second)
}))
Effect.runPromise(program)
//=> 1
//=> 2
runIntoPubSub: {
<function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): <E, R>(self: Stream<A, E, R>) => Effect.Effect<void, E, R>
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; <…;
}
import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): <E, R>(self: Stream<A, E, R>) => Effect.Effect<void, E, R>
options: | {
readonly shutdownOnEnd?: boolean | undefined
}
| undefined
shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | undefined
): <function (type parameter) E in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>E, function (type parameter) R in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>R>(self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
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; <…;
}
interface Stream<out A, out E = never, out R = never>A Stream<A, E, R> describes a program that can emit many A values, fail
with E, and require R.
Details
Streams are pull-based with backpressure and emit chunks to amortize effect
evaluation. They support monadic composition and error handling similar to
Effect, adapted for multiple values.
Example (Creating and consuming streams)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
yield* Stream.make(1, 2, 3).pipe(
Stream.map((n) => n * 2),
Stream.runForEach((n) => Console.log(n))
)
})
Effect.runPromise(program)
// Output:
// 2
// 4
// 6
Stream<function (type parameter) A in <A>(pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): <E, R>(self: Stream<A, E, R>) => Effect.Effect<void, E, R>
function (type parameter) E in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>E, function (type parameter) R in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>R>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void, function (type parameter) E in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>E, function (type parameter) R in <E, R>(self: Stream<A, E, R>): Effect.Effect<void, E, R>R>
<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
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; <…;
}
interface Stream<out A, out E = never, out R = never>A Stream<A, E, R> describes a program that can emit many A values, fail
with E, and require R.
Details
Streams are pull-based with backpressure and emit chunks to amortize effect
evaluation. They support monadic composition and error handling similar to
Effect, adapted for multiple values.
Example (Creating and consuming streams)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
yield* Stream.make(1, 2, 3).pipe(
Stream.map((n) => n * 2),
Stream.runForEach((n) => Console.log(n))
)
})
Effect.runPromise(program)
// Output:
// 2
// 4
// 6
Stream<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
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; <…;
}
import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
options: | {
readonly shutdownOnEnd?: boolean | undefined
}
| undefined
shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | undefined
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void, never, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, never, R>
import dualdual((args: anyargs) => const isStream: (
u: unknown
) => u is Stream<unknown, unknown, unknown>
Checks whether a value is a Stream.
Example (Checking whether a value is a Stream)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const stream = Stream.make(1, 2, 3)
const notStream = { data: [1, 2, 3] }
yield* Console.log(Stream.isStream(stream))
// true
yield* Console.log(Stream.isStream(notStream))
// false
})
Effect.runPromise(program)
isStream(args: anyargs[0]), <function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
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; <…;
}
interface Stream<out A, out E = never, out R = never>A Stream<A, E, R> describes a program that can emit many A values, fail
with E, and require R.
Details
Streams are pull-based with backpressure and emit chunks to amortize effect
evaluation. They support monadic composition and error handling similar to
Effect, adapted for multiple values.
Example (Creating and consuming streams)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
yield* Stream.make(1, 2, 3).pipe(
Stream.map((n) => n * 2),
Stream.runForEach((n) => Console.log(n))
)
})
Effect.runPromise(program)
// Output:
// 2
// 4
// 6
Stream<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
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; <…;
}
import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
options: | {
readonly shutdownOnEnd?: boolean | undefined
}
| undefined
shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | undefined
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, pubsub: PubSub.PubSub<A>, options?: {
readonly shutdownOnEnd?: boolean | undefined;
} | undefined): Effect.Effect<void, E, R>
import ChannelChannel.runIntoPubSubArray(self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
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; <…;
}
Stream<out A, out E = never, out R = never>.channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>(property) Stream<out A, out E = never, out R = never>.channel: {
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: 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; <…;
}
options: | {
readonly shutdownOnEnd?: boolean | undefined
}
| undefined