<A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<
never,
E,
End<A, L>,
NonEmptyReadonlyArray<In>,
never,
void,
R
>Creates a Channel from a Sink.
Example (Converting a sink to a channel)
import { Sink } from "effect"
// Create a sink and extract its channel
const sink = Sink.succeed(42)
const channel = Sink.toChannel(sink)constructors
Source effect/Sink.ts:2819 lines
export const const toChannel: <A, In, L, E, R>(
self: Sink<A, In, L, E, R>
) => Channel.Channel<
never,
E,
End<A, L>,
NonEmptyReadonlyArray<In>,
never,
void,
R
>
Creates a Channel from a Sink.
Example (Converting a sink to a channel)
import { Sink } from "effect"
// Create a sink and extract its channel
const sink = Sink.succeed(42)
const channel = Sink.toChannel(sink)
toChannel = <function (type parameter) A in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>A, function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>In, function (type parameter) L in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>L, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>E, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>R>(
self: Sink<A, In, L, E, R>(parameter) self: {
transform: (upstream: Pull.Pull<NonEmptyReadonlyArray<In>, never, void>, scope: Scope.Scope) => Effect.Effect<End<A, L>, E, 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 Sink<out A, in In = unknown, out L = never, out E = never, out R = never>A Sink<A, In, L, E, R> is used to consume elements produced by a Stream.
You can think of a sink as a function that will consume a variable amount of
In elements (could be 0, 1, or many), might fail with an error of type E,
and will eventually yield a value of type A together with a remainder of
type L (i.e. any leftovers).
Example (Running a sink with a stream)
import { Effect, Sink, Stream } from "effect"
// Create a simple sink that always succeeds with a value
const sink: Sink.Sink<number> = Sink.succeed(42)
// Use the sink to consume a stream
const stream = Stream.make(1, 2, 3)
const program = Stream.run(stream, sink)
Effect.runPromise(program).then(console.log)
// Output: 42
Namespace containing types and interfaces for Sink variance and type relationships.
Sink<function (type parameter) A in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>A, function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>In, function (type parameter) L in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>L, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>E, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>R>
): import ChannelChannel.type Channel.Channel = /*unresolved*/ anyChannel<never, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>E, type End<A, L = never> = readonly [
value: A,
leftover?: any
]
Tuple returned when a Sink finishes.
Details
The first element is the sink result. The optional second element contains a
non-empty array of leftover input that was pulled but not consumed.
End<function (type parameter) A in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>A, function (type parameter) L in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>L>, import NonEmptyReadonlyArrayNonEmptyReadonlyArray<function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>In>, never, void, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Channel.Channel<never, E, End<A, L>, NonEmptyReadonlyArray<In>, never, void, R>R> =>
import ChannelChannel.fromTransform((upstream: Pull.Pull<
readonly [In, ...In[]],
never,
void,
never
>
(parameter) upstream: {
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; <…;
toString: () => string;
toJSON: () => unknown;
}
scope: Scope.Scope(parameter) scope: {
strategy: "sequential" | "parallel";
state: State.Open | State.Closed | State.Empty;
}
import EffectEffect.succeed(import EffectEffect.flatMap(
self: Sink<A, In, L, E, R>(parameter) self: {
transform: (upstream: Pull.Pull<NonEmptyReadonlyArray<In>, never, void>, scope: Scope.Scope) => Effect.Effect<End<A, L>, E, 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; <…;
}
Sink<A, In, L, E, R>.transform: (upstream: Pull.Pull<NonEmptyReadonlyArray<In>, never, void>, scope: Scope.Scope) => Effect.Effect<End<A, L>, E, R>transform(upstream: Pull.Pull<
readonly [In, ...In[]],
never,
void,
never
>
(parameter) upstream: {
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; <…;
toString: () => string;
toJSON: () => unknown;
}
scope: Scope.Scope(parameter) scope: {
strategy: "sequential" | "parallel";
state: State.Open | State.Closed | State.Empty;
}
import CauseCause.done
))
)Referenced by 2 symbols