<AL, EL = never, RL = never>(
layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>,
options?: { readonly local?: boolean | undefined } | undefined
): <A, E, R>(
self: Stream<A, E, R>
) => Stream<A, E | EL, Exclude<R, AL> | RL>
<A, E, R, AL, EL = never, RL = never>(
self: Stream<A, E, R>,
layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>,
options?: { readonly local?: boolean | undefined } | undefined
): Stream<A, E | EL, Exclude<R, AL> | RL>Provides a layer or context to the stream, removing the corresponding
service requirements. Use options.local to build the layer every time; by
default, layers are shared between provide calls.
Example (Providing stream requirements)
import { Console, Context, Effect, Layer, Stream } from "effect"
class Env extends Context.Service<Env, { readonly name: string }>()("Env") {}
const layer = Layer.succeed(Env)({ name: "Ada" })
const stream = Stream.fromEffect(
Effect.gen(function*() {
const env = yield* Effect.service(Env)
return `Hello, ${env.name}`
})
)
const withEnv = stream.pipe(Stream.provide(layer))
const program = Stream.runCollect(withEnv).pipe(
Effect.flatMap((values) => Console.log(values))
)
Effect.runPromise(program)
// Output:
// ["Hello, Ada"]services
Source effect/Stream.ts:1003123 lines
export const const provide: {
<AL, EL = never, RL = never>(
layer:
| Layer.Layer<AL, EL, RL>
| Context.Context<AL>,
options?:
| { readonly local?: boolean | undefined }
| undefined
): <A, E, R>(
self: Stream<A, E, R>
) => Stream<A, E | EL, Exclude<R, AL> | RL>
<A, E, R, AL, EL = never, RL = never>(
self: Stream<A, E, R>,
layer:
| Layer.Layer<AL, EL, RL>
| Context.Context<AL>,
options?:
| { readonly local?: boolean | undefined }
| undefined
): Stream<A, E | EL, Exclude<R, AL> | RL>
}
Provides a layer or context to the stream, removing the corresponding
service requirements. Use options.local to build the layer every time; by
default, layers are shared between provide calls.
Example (Providing stream requirements)
import { Console, Context, Effect, Layer, Stream } from "effect"
class Env extends Context.Service<Env, { readonly name: string }>()("Env") {}
const layer = Layer.succeed(Env)({ name: "Ada" })
const stream = Stream.fromEffect(
Effect.gen(function*() {
const env = yield* Effect.service(Env)
return `Hello, ${env.name}`
})
)
const withEnv = stream.pipe(Stream.provide(layer))
const program = Stream.runCollect(withEnv).pipe(
Effect.flatMap((values) => Console.log(values))
)
Effect.runPromise(program)
// Output:
// ["Hello, Ada"]
provide: {
<function (type parameter) AL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
layer: | Layer.Layer<AL, EL, RL>
| Context.Context<AL>
import LayerLayer.type Layer.Layer = /*unresolved*/ anyLayer<function (type parameter) AL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
import ContextContext.type Context.Context = /*unresolved*/ anyContext<function (type parameter) AL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
options: | {
readonly local?: boolean | undefined
}
| undefined
local?: boolean | undefinedlocal?: boolean | undefined
} | undefined
): <function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>R>(
self: Stream<A, 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<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>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) A in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>E | function (type parameter) EL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
type Exclude<T, U> = T extends U
? never
: T
Exclude from T those types that are assignable to U
Exclude<function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E | EL, Exclude<R, AL> | RL>R, function (type parameter) AL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <AL, EL = never, RL = never>(layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) A in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
self: Stream<A, 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<function (type parameter) A in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
layer: | Layer.Layer<AL, EL, RL>
| Context.Context<AL>
import LayerLayer.type Layer.Layer = /*unresolved*/ anyLayer<function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
import ContextContext.type Context.Context = /*unresolved*/ anyContext<function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
options: | {
readonly local?: boolean | undefined
}
| undefined
local?: boolean | undefinedlocal?: boolean | undefined
} | 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, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
type Exclude<T, U> = T extends U
? never
: T
Exclude from T those types that are assignable to U
Exclude<function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
import dualdual((args: anyargs) => const isStream: (
u: unknown
) => u is Stream<unknown, unknown, unknown>
Checks whether a value is a Stream.
Example (Checking whether a value is a Stream)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const stream = Stream.make(1, 2, 3)
const notStream = { data: [1, 2, 3] }
yield* Console.log(Stream.isStream(stream))
// true
yield* Console.log(Stream.isStream(notStream))
// false
})
Effect.runPromise(program)
isStream(args: anyargs[0]), <function (type parameter) A in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
self: Stream<A, 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<function (type parameter) A in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
layer: | Layer.Layer<AL, EL, RL>
| Context.Context<AL>
import LayerLayer.type Layer.Layer = /*unresolved*/ anyLayer<function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
import ContextContext.type Context.Context = /*unresolved*/ anyContext<function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
options: | {
readonly local?: boolean | undefined
}
| undefined
local?: boolean | undefinedlocal?: boolean | undefined
} | 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, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) E in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) EL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
type Exclude<T, U> = T extends U
? never
: T
Exclude from T those types that are assignable to U
Exclude<function (type parameter) R in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) AL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
function (type parameter) RL in <A, E, R, AL, EL = never, RL = never>(self: Stream<A, E, R>, layer: Layer.Layer<AL, EL, RL> | Context.Context<AL>, options?: {
readonly local?: boolean | undefined;
} | undefined): Stream<A, E | EL, Exclude<R, AL> | RL>
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.provide(self: Stream<A, 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<out A, out E = never, out R = never>.channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>(property) Stream<out A, out E = never, out R = never>.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; <…;
}
layer: | Layer.Layer<AL, EL, RL>
| Context.Context<AL>
options: | {
readonly local?: boolean | undefined
}
| undefined
Referenced by 1 symbols