<E, R>(self: Stream<string, E, R>): Stream<string, E, R>Splits a stream of strings into lines, handling \n, \r, and \r\n delimiters across chunks.
Example (Splitting streamed text into lines)
import { Console, Effect, Stream } from "effect"
Effect.runPromise(Effect.gen(function* () {
const lines = yield* Stream.runCollect(
Stream.make("a\nb\r\n", "c\n").pipe(Stream.splitLines)
)
yield* Console.log(lines)
}))
// ["a", "b", "c"]export const const splitLines: <E, R>(
self: Stream<string, E, R>
) => Stream<string, E, R>
Splits a stream of strings into lines, handling \n, \r, and \r\n delimiters across chunks.
Example (Splitting streamed text into lines)
import { Console, Effect, Stream } from "effect"
Effect.runPromise(Effect.gen(function* () {
const lines = yield* Stream.runCollect(
Stream.make("a\nb\r\n", "c\n").pipe(Stream.splitLines)
)
yield* Console.log(lines)
}))
// ["a", "b", "c"]
splitLines = <function (type parameter) E in <E, R>(self: Stream<string, E, R>): Stream<string, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<string, E, R>R>(self: Stream<string, 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<string, function (type parameter) E in <E, R>(self: Stream<string, E, R>): Stream<string, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<string, 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<string, function (type parameter) E in <E, R>(self: Stream<string, E, R>): Stream<string, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<string, E, R>R> =>
self: Stream<string, 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<string, E, R>.channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>(property) Stream<string, E, R>.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; <…;
}
Pipeable.pipe<Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>, Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>, Stream<string, E, R>>(this: Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>, ab: (_: Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>) => Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>, bc: (_: Channel.Channel<readonly [string, ...string[]], E, void, unknown, unknown, unknown, R>) => Stream<string, E, R>): Stream<string, E, R> (+21 overloads)pipe(
import ChannelChannel.const pipeTo: {
<
OutElem2,
OutErr2,
OutDone2,
OutElem,
OutErr,
OutDone,
Env2
>(
that: Channel<
OutElem2,
OutErr2,
OutDone2,
OutElem,
OutErr,
OutDone,
Env2
>
): <InElem, InErr, InDone, Env>(
self: Channel<
OutElem,
OutErr,
OutDone,
InElem,
InErr,
InDone,
Env
>
) => Channel<
OutElem2,
OutErr2,
OutDone2,
InElem,
InErr,
InDone,
Env2 | Env
>
<
OutElem,
OutErr,
OutDone,
InElem,
InErr,
InDone,
Env,
OutElem2,
OutErr2,
OutDone2,
Env2
>(
self: Channel<
OutElem,
OutErr,
OutDone,
InElem,
InErr,
InDone,
Env
>,
that: Channel<
OutElem2,
OutErr2,
OutDone2,
OutElem,
OutErr,
OutDone,
Env2
>
): Channel<
OutElem2,
OutErr2,
OutDone2,
InElem,
InErr,
InDone,
Env2 | Env
>
}
import ChannelChannel.const splitLines: <
Err,
Done
>() => Channel<
Arr.NonEmptyReadonlyArray<string>,
Err,
Done,
Arr.NonEmptyReadonlyArray<string>,
Err,
Done
>
Splits upstream string chunks into lines, recognizing \n, \r\n, and
standalone \r as line terminators. The behavior matches
String.linesIterator regardless of how the input is chunked.
Details
A line terminator at the very end of the stream does not produce a
trailing empty line (consistent with String.linesIterator). Conversely,
if the stream ends without a terminator the final partial line is still
emitted.
Example (Splitting string chunks into lines)
import { Effect, Stream } from "effect"
Effect.runPromise(Effect.gen(function*() {
const result = yield* Stream.runCollect(
Stream.splitLines(Stream.make("hel", "lo\r\nwor", "ld\n"))
)
console.log(result)
// [ 'hello', 'world' ]
}))
splitLines()),
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
)