<E, R>(self: Stream<string, E, R>): Stream<Uint8Array, E, R>Encodes a stream of strings into UTF-8 Uint8Array chunks.
Example (Encoding a stream of strings into UTF-8 Uint8Array chunks)
import { Console, Effect, Stream } from "effect"
const stream = Stream.make("Hello", " ", "World")
const program = Effect.gen(function*() {
const encoded = Stream.encodeText(stream)
const chunks = yield* Stream.runCollect(encoded)
const bytes = chunks.map((chunk) => [...chunk])
yield* Console.log(bytes)
})
Effect.runPromise(program)
// [[72, 101, 108, 108, 111], [32], [87, 111, 114, 108, 100]]export const const encodeText: <E, R>(
self: Stream<string, E, R>
) => Stream<Uint8Array, E, R>
Encodes a stream of strings into UTF-8 Uint8Array chunks.
Example (Encoding a stream of strings into UTF-8 Uint8Array chunks)
import { Console, Effect, Stream } from "effect"
const stream = Stream.make("Hello", " ", "World")
const program = Effect.gen(function*() {
const encoded = Stream.encodeText(stream)
const chunks = yield* Stream.runCollect(encoded)
const bytes = chunks.map((chunk) => [...chunk])
yield* Console.log(bytes)
})
Effect.runPromise(program)
// [[72, 101, 108, 108, 111], [32], [87, 111, 114, 108, 100]]
encodeText = <function (type parameter) E in <E, R>(self: Stream<string, E, R>): Stream<Uint8Array, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<Uint8Array, 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<Uint8Array, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<Uint8Array, 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<interface Uint8Array<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike>A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the
requested number of bytes could not be allocated an exception is raised.
Uint8Array, function (type parameter) E in <E, R>(self: Stream<string, E, R>): Stream<Uint8Array, E, R>E, function (type parameter) R in <E, R>(self: Stream<string, E, R>): Stream<Uint8Array, E, R>R> =>
const suspend: <A, E, R>(
stream: LazyArg<Stream<A, E, R>>
) => Stream<A, E, R>
Creates a lazily constructed stream.
Details
The stream factory is evaluated each time the stream is run.
Example (Creating a lazily constructed stream)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const values = yield* Stream.suspend(() => Stream.make(1, 2, 3)).pipe(Stream.runCollect)
yield* Console.log(values)
})
Effect.runPromise(program)
// Output: [ 1, 2, 3 ]
suspend(() => {
const const encoder: TextEncoderencoder = new var TextEncoder: new () => TextEncoderThe TextEncoder interface takes a stream of code points as input and emits a stream of UTF-8 bytes.
TextEncoder()
return const map: {
<A, B>(f: (a: A, i: number) => B): <E, R>(
self: Stream<A, E, R>
) => Stream<B, E, R>
<A, E, R, B>(
self: Stream<A, E, R>,
f: (a: A, i: number) => B
): Stream<B, E, 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; <…;
}
chunk: stringchunk) => const encoder: TextEncoderencoder.TextEncoder.encode(input?: string): Uint8Array<ArrayBuffer>The TextEncoder.encode() method takes a string as input, and returns a Global_Objects/Uint8Array containing the text given in parameters encoded with the specific method for that TextEncoder object.
encode(chunk: stringchunk))
})