<O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>Creates a stream that emits each output of a schedule that does not require input, for as long as the schedule continues.
Example (Creating a stream from a schedule)
import { Console, Effect, Schedule, Stream } from "effect"
const program = Effect.gen(function*() {
const schedule = Schedule.spaced("50 millis").pipe(
Schedule.upTo({ times: 3 })
)
const stream = Stream.fromSchedule(schedule)
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 0, 1, 2 ]constructors
Source effect/Stream.ts:14887 lines
export const const fromSchedule: <O, E, R>(
schedule: Schedule.Schedule<O, unknown, E, R>
) => Stream<O, E, R>
Creates a stream that emits each output of a schedule that does not require input,
for as long as the schedule continues.
Example (Creating a stream from a schedule)
import { Console, Effect, Schedule, Stream } from "effect"
const program = Effect.gen(function*() {
const schedule = Schedule.spaced("50 millis").pipe(
Schedule.upTo({ times: 3 })
)
const stream = Stream.fromSchedule(schedule)
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 0, 1, 2 ]
fromSchedule = <function (type parameter) O in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>O, function (type parameter) E in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>E, function (type parameter) R in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>R>(schedule: Schedule.Schedule<O, unknown, E, R>(parameter) schedule: {
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 ScheduleSchedule.type Schedule.Schedule = /*unresolved*/ anySchedule<function (type parameter) O in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>O, unknown, function (type parameter) E in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>E, function (type parameter) R in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, 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) O in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>O, function (type parameter) E in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>E, function (type parameter) R in <O, E, R>(schedule: Schedule.Schedule<O, unknown, E, R>): Stream<O, E, R>R> =>
const fromPull: <A, E, R, EX, RX>(
pull: Effect.Effect<
Pull.Pull<
Arr.NonEmptyReadonlyArray<A>,
E,
void,
R
>,
EX,
RX
>
) => Stream<A, Pull.ExcludeDone<E> | EX, R | RX>
Creates a stream from a pull effect, such as one produced by Stream.toPull.
Details
A pull effect yields chunks on demand and completes when the upstream stream ends.
See Stream.toPull for a matching producer.
Example (Creating a stream from a pull effect)
import { Console, Effect, Stream } from "effect"
const program = Effect.scoped(
Effect.gen(function*() {
const source = Stream.make(1, 2, 3)
const pull = yield* Stream.toPull(source)
const stream = Stream.fromPull(Effect.succeed(pull))
const values = yield* Stream.runCollect(stream)
yield* Console.log(values)
})
)
Effect.runPromise(program)
// Output: [1, 2, 3]
fromPull(
import EffectEffect.map(
import ScheduleSchedule.toStepWithSleep(schedule: Schedule.Schedule<O, unknown, E, R>(parameter) schedule: {
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; <…;
}
step: anystep) => import PullPull.catchDone(import EffectEffect.map(step: anystep(void 0), import ArrArr.of), () => import CauseCause.done())
)
)