<In0, In, E2, R2>(
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>
): <A, L, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A, In0, L, E2 | E, R2 | R>
<A, In, L, E, R, In0, E2, R2>(
self: Sink<A, In, L, E, R>,
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>
): Sink<A, In0, L, E | E2, R | R2>Transforms each non-empty array of upstream input effectfully before it is fed to this sink.
mapping
Source effect/Sink.ts:96821 lines
export const const mapInputArrayEffect: {
<In0, In, E2, R2>(
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
): <A, L, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A, In0, L, E2 | E, R2 | R>
<A, In, L, E, R, In0, E2, R2>(
self: Sink<A, In, L, E, R>,
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
): Sink<A, In0, L, E | E2, R | R2>
}
Transforms each non-empty array of upstream input effectfully before it is
fed to this sink.
mapInputArrayEffect: {
<function (type parameter) In0 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In0, function (type parameter) In in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In, function (type parameter) E2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>E2, function (type parameter) R2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>R2>(
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
input: Arr.NonEmptyReadonlyArray<In0>(parameter) input: {
0: In0;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<In0>>): Array<In0>; (...items: Array<In0 | ConcatArray<In0>>): Array<In0> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<In0>;
indexOf: (searchElement: In0, fromIndex?: number) => number;
lastIndexOf: (searchElement: In0, fromIndex?: number) => number;
every: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): boolean };
some: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => void, thisArg?: any) => void;
map: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): Array<S>; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): Array<In0> };
reduce: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
reduceRight: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
find: { (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findIndex: (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, In0]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<In0>;
includes: (searchElement: In0, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: In0, index: number, array: Array<In0>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => In0 | undefined;
findLast: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findLastIndex: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
toReversed: () => Array<In0>;
toSorted: (compareFn?: ((a: In0, b: In0) => number) | undefined) => Array<In0>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<In0>): Array<In0>; (start: number, deleteCount?: number): Array<In0> };
with: (index: number, value: In0) => Array<In0>;
}
import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In0 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In0>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In>, function (type parameter) E2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>E2, function (type parameter) R2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>R2>
): <function (type parameter) A in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>A, function (type parameter) L in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>L, function (type parameter) E in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>E, function (type parameter) R in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | 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, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>A, function (type parameter) In in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In, function (type parameter) L in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>L, function (type parameter) E in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>E, function (type parameter) R in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | 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, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>A, function (type parameter) In0 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>In0, function (type parameter) L in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>L, function (type parameter) E2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>E2 | function (type parameter) E in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>E, function (type parameter) R2 in <In0, In, E2, R2>(f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>R2 | function (type parameter) R in <A, L, E, R>(self: Sink<A, In, L, E, R>): Sink<A, In0, L, E2 | E, R2 | R>R>
<function (type parameter) A in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R, function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0, function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2>(
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, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R>,
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
input: Arr.NonEmptyReadonlyArray<In0>(parameter) input: {
0: In0;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<In0>>): Array<In0>; (...items: Array<In0 | ConcatArray<In0>>): Array<In0> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<In0>;
indexOf: (searchElement: In0, fromIndex?: number) => number;
lastIndexOf: (searchElement: In0, fromIndex?: number) => number;
every: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): boolean };
some: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => void, thisArg?: any) => void;
map: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): Array<S>; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): Array<In0> };
reduce: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
reduceRight: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
find: { (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findIndex: (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, In0]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<In0>;
includes: (searchElement: In0, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: In0, index: number, array: Array<In0>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => In0 | undefined;
findLast: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findLastIndex: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
toReversed: () => Array<In0>;
toSorted: (compareFn?: ((a: In0, b: In0) => number) | undefined) => Array<In0>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<In0>): Array<In0>; (start: number, deleteCount?: number): Array<In0> };
with: (index: number, value: In0) => Array<In0>;
}
import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In>, function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2>
): 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, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E | function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R | function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2>
} = import dualdual(
2,
<function (type parameter) A in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R, function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0, function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2>(
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, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R>,
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
input: Arr.NonEmptyReadonlyArray<In0>(parameter) input: {
0: In0;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<In0>>): Array<In0>; (...items: Array<In0 | ConcatArray<In0>>): Array<In0> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<In0>;
indexOf: (searchElement: In0, fromIndex?: number) => number;
lastIndexOf: (searchElement: In0, fromIndex?: number) => number;
every: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): boolean };
some: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => void, thisArg?: any) => void;
map: (callbackfn: (value: In0, index: number, array: ReadonlyArray<In0>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): Array<S>; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): Array<In0> };
reduce: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
reduceRight: { (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0): In0; (callbackfn: (previousValue: In0, currentValue: In0, currentIndex: number, array: ReadonlyArray<In0>) => In0, initialValu…;
find: { (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findIndex: (predicate: (value: In0, index: number, obj: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, In0]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<In0>;
includes: (searchElement: In0, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: In0, index: number, array: Array<In0>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => In0 | undefined;
findLast: { (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => value is S, thisArg?: any): S | undefined; (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any): In0 | undefined };
findLastIndex: (predicate: (value: In0, index: number, array: ReadonlyArray<In0>) => unknown, thisArg?: any) => number;
toReversed: () => Array<In0>;
toSorted: (compareFn?: ((a: In0, b: In0) => number) | undefined) => Array<In0>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<In0>): Array<In0>; (start: number, deleteCount?: number): Array<In0> };
with: (index: number, value: In0) => Array<In0>;
}
import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0>) => import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) In in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In>, function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2>
): 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, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>A, function (type parameter) In0 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>In0, function (type parameter) L in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>L, function (type parameter) E in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E | function (type parameter) E2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>E2, function (type parameter) R in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R | function (type parameter) R2 in <A, In, L, E, R, In0, E2, R2>(self: Sink<A, In, L, E, R>, f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>): Sink<A, In0, L, E | E2, R | R2>R2> =>
const fromTransform: <
In,
A,
E,
R,
L = never
>(
transform: (
upstream: Pull.Pull<
NonEmptyReadonlyArray<In>,
never,
void
>,
scope: Scope.Scope
) => Effect.Effect<End<A, L>, E, R>
) => Sink<A, In, L, E, R>
Creates a Sink from a low-level transform function.
Details
The transform receives the upstream pull of non-empty input arrays and the
active scope, and returns an effect that completes with the sink's End
value.
fromTransform((upstream: Pull.Pull<
readonly [In0, ...In0[]],
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;
}
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(
import EffectEffect.flatMap(upstream: Pull.Pull<
readonly [In0, ...In0[]],
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;
}
f: (
input: Arr.NonEmptyReadonlyArray<In0>
) => Effect.Effect<
Arr.NonEmptyReadonlyArray<In>,
E2,
R2
>
scope: Scope.Scope(parameter) scope: {
strategy: "sequential" | "parallel";
state: State.Open | State.Closed | State.Empty;
}
Referenced by 1 symbols