<A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>Drops leftovers produced by a sink.
Details
The sink result is preserved, but any leftover elements are discarded instead of being returned to downstream sink composition. This does not continue pulling additional elements from the upstream stream.
export const const ignoreLeftover: <A, In, L, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A, In, never, E, R>
Drops leftovers produced by a sink.
Details
The sink result is preserved, but any leftover elements are discarded
instead of being returned to downstream sink composition. This does not
continue pulling additional elements from the upstream stream.
ignoreLeftover = <function (type parameter) A in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>A, function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>In, function (type parameter) L in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>L, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>E, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, 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>): Sink<A, In, never, E, R>A, function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>In, function (type parameter) L in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>L, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>E, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>R>): 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>): Sink<A, In, never, E, R>A, function (type parameter) In in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>In, never, function (type parameter) E in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>E, function (type parameter) R in <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, never, E, R>R> =>
const mapEnd: {
<A, L, A2, L2 = never>(
f: (a: End<A, L>) => End<A2, L2>
): <In, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A2, In, L2, E, R>
<A, In, L, E, R, A2, L2 = never>(
self: Sink<A, In, L, E, R>,
f: (a: End<A, L>) => End<A2, L2>
): Sink<A2, In, L2, E, 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; <…;
}
a: Aa]) => [a: Aa])