(
options:
| {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
): <A, E, R>(
self: Stream<A, E, R>
) => Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
<A, E, R>(
self: Stream<A, E, R>,
options:
| {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>Converts a stream to a PubSub of emitted values for concurrent consumption.
Details
shutdownOnEnd indicates whether the PubSub should be shut down when the
stream ends. By default this is true.
Example (Converting a stream to a PubSub for concurrent consumption)
import { Console, Effect, PubSub, Stream } from "effect"
const program = Effect.scoped(Effect.gen(function* () {
const pubsub = yield* Stream.fromArray([1, 2]).pipe(
Stream.toPubSub({ capacity: 8 })
)
const subscription = yield* PubSub.subscribe(pubsub)
const first = yield* PubSub.take(subscription)
yield* Console.log(first)
}))destructors
Source effect/Stream.ts:1152042 lines
export const const toPubSub: {
(
options:
| {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?:
| boolean
| undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?:
| boolean
| undefined
}
): <A, E, R>(
self: Stream<A, E, R>
) => Effect.Effect<
PubSub.PubSub<A>,
never,
R | Scope.Scope
>
<A, E, R>(
self: Stream<A, E, R>,
options:
| {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?:
| boolean
| undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?:
| boolean
| undefined
}
): Effect.Effect<
PubSub.PubSub<A>,
never,
R | Scope.Scope
>
}
Converts a stream to a PubSub of emitted values for concurrent consumption.
Details
shutdownOnEnd indicates whether the PubSub should be shut down when the
stream ends. By default this is true.
Example (Converting a stream to a PubSub for concurrent consumption)
import { Console, Effect, PubSub, Stream } from "effect"
const program = Effect.scoped(Effect.gen(function* () {
const pubsub = yield* Stream.fromArray([1, 2]).pipe(
Stream.toPubSub({ capacity: 8 })
)
const subscription = yield* PubSub.subscribe(pubsub)
const first = yield* PubSub.take(subscription)
yield* Console.log(first)
}))
toPubSub: {
(
options: | {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
capacity: "unbounded"capacity: "unbounded"
readonly replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | {
readonly capacity: numbercapacity: number
readonly strategy?: | "suspend"
| "sliding"
| "dropping"
| undefined
replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
}
): <function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>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>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>R>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>A>, never, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>R | import ScopeScope.type Scope.Scope = /*unresolved*/ anyScope>
<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
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>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
options: | {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
capacity: "unbounded"capacity: "unbounded"
readonly replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | {
readonly capacity: numbercapacity: number
readonly strategy?: | "suspend"
| "sliding"
| "dropping"
| undefined
replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
}
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
import ScopeScope.type Scope.Scope = /*unresolved*/ anyScope>
} = import dualdual(
2,
<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
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>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) E in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
options: | {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
capacity: "unbounded"capacity: "unbounded"
readonly replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
} | {
readonly capacity: numbercapacity: number
readonly strategy?: | "suspend"
| "sliding"
| "dropping"
| undefined
replay?: number | undefinedreplay?: number | undefined
readonly shutdownOnEnd?: boolean | undefinedshutdownOnEnd?: boolean | undefined
}
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import PubSubPubSub.type PubSub.PubSub = /*unresolved*/ anyPubSub<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
function (type parameter) R in <A, E, R>(self: Stream<A, E, R>, options: {
readonly capacity: "unbounded";
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
} | {
readonly capacity: number;
readonly strategy?: "dropping" | "sliding" | "suspend" | undefined;
readonly replay?: number | undefined;
readonly shutdownOnEnd?: boolean | undefined;
}): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>
import ScopeScope.type Scope.Scope = /*unresolved*/ anyScope> => import ChannelChannel.toPubSubArray(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; <…;
}
options: | {
readonly capacity: "unbounded"
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}
| {
readonly capacity: number
readonly strategy?:
| "dropping"
| "sliding"
| "suspend"
| undefined
readonly replay?: number | undefined
readonly shutdownOnEnd?: boolean | undefined
}