<L, L2>(f: (leftover: L) => L2): <A, In, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A, In, L2, E, R>
<A, In, L, E, R, L2>(
self: Sink<A, In, L, E, R>,
f: (leftover: L) => L2
): Sink<A, In, L2, E, R>Transforms the leftovers emitted by this sink using f.
mapping
Source effect/Sink.ts:11017 lines
export const const mapLeftover: {
<L, L2>(f: (leftover: L) => L2): <A, In, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A, In, L2, E, R>
<A, In, L, E, R, L2>(
self: Sink<A, In, L, E, R>,
f: (leftover: L) => L2
): Sink<A, In, L2, E, R>
}
Transforms the leftovers emitted by this sink using f.
mapLeftover: {
<function (type parameter) L in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L, function (type parameter) L2 in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L2>(f: (leftover: L) => L2f: (leftover: Lleftover: function (type parameter) L in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L) => function (type parameter) L2 in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L2): <function (type parameter) A in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>In, function (type parameter) E in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, 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, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>In, function (type parameter) L in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L, function (type parameter) E in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, 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, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>In, function (type parameter) L2 in <L, L2>(f: (leftover: L) => L2): <A, In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L2, E, R>L2, function (type parameter) E in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In, L2, E, R>R>
<function (type parameter) A in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>R, function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2>(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, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>R>, f: (leftover: L) => L2f: (leftover: Lleftover: function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L) => function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2): 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, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>R>
} = dual<(...args: Array<any>) => any, <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2) => Sink<A, In, L2, E, R>>(arity: 2, body: <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2) => Sink<A, In, L2, E, R>): ((...args: Array<any>) => any) & (<A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2) => Sink<A, In, L2, E, R>) (+1 overload)Creates a function that can be called in data-first style or data-last
(pipe-friendly) style.
When to use
Use to expose one implementation through both direct and pipe-friendly
call styles.
Details
Pass either the arity of the uncurried function or a predicate that decides
whether the current call is data-first. Arity is the common case. Use a
predicate when optional arguments make arity ambiguous.
Example (Selecting data-first or data-last style by arity)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(2, (self, that) => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Defining overloads with call signatures)
import { Function, pipe } from "effect"
const sum: {
(that: number): (self: number) => number
(self: number, that: number): number
} = Function.dual(2, (self: number, that: number): number => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Selecting data-first or data-last style with a predicate)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(
(args) => args.length === 2,
(self, that) => self + that
)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
dual(2, <function (type parameter) A in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>R, function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2>(
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, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>R>,
f: (leftover: L) => L2f: (leftover: Lleftover: function (type parameter) L in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L) => function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2
): 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, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>A, function (type parameter) In in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>In, function (type parameter) L2 in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>L2, function (type parameter) E in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, E, R>E, function (type parameter) R in <A, In, L, E, R, L2>(self: Sink<A, In, L, E, R>, f: (leftover: L) => L2): Sink<A, In, L2, 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, l: readonly [L, ...L[]] | undefinedl]) => [a: Aa, l: readonly [L, ...L[]] | undefinedl && import ArrArr.const map: <readonly [L, ...L[]], L2>(self: readonly [L, ...L[]], f: (a: L, i: number) => L2) => [L2, ...L2[]] (+1 overload)map(l: readonly [L, ...L[]](parameter) l: {
0: L;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<L>>): Array<L>; (...items: Array<L | ConcatArray<L>>): Array<L> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<L>;
indexOf: (searchElement: L, fromIndex?: number) => number;
lastIndexOf: (searchElement: L, fromIndex?: number) => number;
every: { (predicate: (value: L, index: number, array: ReadonlyArray<L>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: L, index: number, array: ReadonlyArray<L>) => unknown, thisArg?: any): boolean };
some: (predicate: (value: L, index: number, array: ReadonlyArray<L>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: L, index: number, array: ReadonlyArray<L>) => void, thisArg?: any) => void;
map: (callbackfn: (value: L, index: number, array: ReadonlyArray<L>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: L, index: number, array: ReadonlyArray<L>) => value is S, thisArg?: any): Array<S>; (predicate: (value: L, index: number, array: ReadonlyArray<L>) => unknown, thisArg?: any): Array<L> };
reduce: { (callbackfn: (previousValue: L, currentValue: L, currentIndex: number, array: ReadonlyArray<L>) => L): L; (callbackfn: (previousValue: L, currentValue: L, currentIndex: number, array: ReadonlyArray<L>) => L, initialValue: L): L; (callbac…;
reduceRight: { (callbackfn: (previousValue: L, currentValue: L, currentIndex: number, array: ReadonlyArray<L>) => L): L; (callbackfn: (previousValue: L, currentValue: L, currentIndex: number, array: ReadonlyArray<L>) => L, initialValue: L): L; (callbac…;
find: { (predicate: (value: L, index: number, obj: ReadonlyArray<L>) => value is S, thisArg?: any): S | undefined; (predicate: (value: L, index: number, obj: ReadonlyArray<L>) => unknown, thisArg?: any): L | undefined };
findIndex: (predicate: (value: L, index: number, obj: ReadonlyArray<L>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, L]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<L>;
includes: (searchElement: L, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: L, index: number, array: Array<L>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => L | undefined;
findLast: { (predicate: (value: L, index: number, array: ReadonlyArray<L>) => value is S, thisArg?: any): S | undefined; (predicate: (value: L, index: number, array: ReadonlyArray<L>) => unknown, thisArg?: any): L | undefined };
findLastIndex: (predicate: (value: L, index: number, array: ReadonlyArray<L>) => unknown, thisArg?: any) => number;
toReversed: () => Array<L>;
toSorted: (compareFn?: ((a: L, b: L) => number) | undefined) => Array<L>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<L>): Array<L>; (start: number, deleteCount?: number): Array<L> };
with: (index: number, value: L) => Array<L>;
}
f: (leftover: L) => L2f)]))