<Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(
channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>
): Stream<
Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never,
E,
R
>Creates a stream from a array-emitting Channel.
Example (Creating a stream from an array-emitting channel)
import { Channel, Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const channel = Channel.succeed([1, 2, 3] as const)
const stream = Stream.fromChannel(channel)
const result = yield* Stream.runCollect(stream)
yield* Console.log(result)
})
// Output: [ 1, 2, 3 ]constructors
Source effect/Stream.ts:3393 lines
export const const fromChannel: <
Arr extends Arr.NonEmptyReadonlyArray<any>,
E,
R
>(
channel: Channel.Channel<
Arr,
E,
void,
unknown,
unknown,
unknown,
R
>
) => Stream<
Arr extends Arr.NonEmptyReadonlyArray<infer A>
? A
: never,
E,
R
>
Creates a stream from a array-emitting Channel.
Example (Creating a stream from an array-emitting channel)
import { Channel, Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const channel = Channel.succeed([1, 2, 3] as const)
const stream = Stream.fromChannel(channel)
const result = yield* Stream.runCollect(stream)
yield* Console.log(result)
})
// Output: [ 1, 2, 3 ]
fromChannel: <function (type parameter) Arr in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>Arr extends import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<any>, function (type parameter) E in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>E, function (type parameter) R in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>R>(
channel: Channel.Channel<
Arr,
E,
void,
unknown,
unknown,
unknown,
R
>
(parameter) 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; <…;
}
import ChannelChannel.type Channel.Channel = /*unresolved*/ anyChannel<function (type parameter) Arr in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>Arr, function (type parameter) E in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>E, void, unknown, unknown, unknown, function (type parameter) R in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>R>
) => 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) Arr in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>Arr extends import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<infer function (type parameter) AA> ? function (type parameter) AA : never, function (type parameter) E in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>E, function (type parameter) R in <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>): Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>R> = import internalinternal.const fromChannel: <
A extends Arr.NonEmptyReadonlyArray<any>,
E,
R
>(
channel: Channel.Channel<
A,
E,
void,
unknown,
unknown,
unknown,
R
>
) => Stream<
A extends Arr.NonEmptyReadonlyArray<infer A>
? A
: never,
E,
R
>
Referenced by 96 symbols
Stream.aggregateWithinStream.broadcastNStream.bufferStream.bufferArrayStream.callbackStream.catchCauseStream.catchCauseFilterStream.catchCauseIfStream.catchFilterStream.catchIfStream.catchReasonStream.catchReasonsStream.chunksStream.combineStream.combineArrayStream.dieStream.drainStream.emptyStream.ensuringStream.failStream.failCauseStream.failCauseSyncStream.failSyncStream.filterStream.filterEffectStream.filterMapStream.filterMapEffectStream.flatMapStream.flattenArrayStream.flattenTakeStream.foreverStream.fromArrayStream.fromArraysStream.fromAsyncIterableStream.fromEffectStream.fromIterableStream.fromIteratorSucceedStream.fromPubSubStream.fromPubSubTakeStream.fromPull+56 more