<A>(
iterable: Iterable<A>,
options?: { readonly chunkSize?: number | undefined }
): Stream<A>Creates a new Stream from an iterable collection of values.
Details
chunkSize: Maximum number of values emitted per chunk.
Example (Creating a stream from an iterable)
import { Console, Effect, Stream } from "effect"
const numbers = [1, 2, 3]
const program = Effect.gen(function*() {
const stream = Stream.fromIterable(numbers)
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 1, 2, 3 ]constructors
Source effect/Stream.ts:11029 lines
export const const fromIterable: <A>(
iterable: Iterable<A>,
options?: {
readonly chunkSize?: number | undefined
}
) => Stream<A>
Creates a new Stream from an iterable collection of values.
Details
chunkSize: Maximum number of values emitted per chunk.
Example (Creating a stream from an iterable)
import { Console, Effect, Stream } from "effect"
const numbers = [1, 2, 3]
const program = Effect.gen(function*() {
const stream = Stream.fromIterable(numbers)
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 1, 2, 3 ]
fromIterable = <function (type parameter) A in <A>(iterable: Iterable<A>, options?: {
readonly chunkSize?: number | undefined;
}): Stream<A>
iterable: Iterable<A>iterable: import IterableIterable<function (type parameter) A in <A>(iterable: Iterable<A>, options?: {
readonly chunkSize?: number | undefined;
}): Stream<A>
options: | {
readonly chunkSize?: number | undefined
}
| undefined
chunkSize?: number | undefinedchunkSize?: number | undefined
}
): 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>(iterable: Iterable<A>, options?: {
readonly chunkSize?: number | undefined;
}): Stream<A>
var Array: ArrayConstructorArray.ArrayConstructor.isArray(arg: any): arg is any[]isArray(iterable: Iterable<A>iterable) && options: | {
readonly chunkSize?: number | undefined
}
| undefined
chunkSize?: number | undefinedchunkSize === var undefinedundefined
? const fromArray: <A>(
array: ReadonlyArray<A>
) => Stream<A>
Creates a stream from an array of values.
Example (Creating a stream from an array of values)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const stream = Stream.fromArray([1, 2, 3])
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 1, 2, 3 ]
fromArray(iterable: any[]iterable)
: 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(import ChannelChannel.fromIterableArray(iterable: Iterable<A>iterable, options: | {
readonly chunkSize?: number | undefined
}
| undefined
chunkSize?: number | undefinedchunkSize))Referenced by 6 symbols