<S, In, E = never, R = never>(
s: LazyArg<S>,
max: number,
f: (s: S, input: In) => Effect.Effect<S, E, R>
): Sink<S, In, In, E, R>Folds input elements into state until the specified maximum number of elements has been consumed or the upstream stream ends.
Details
If the sink stops in the middle of a pulled array, the remaining elements from that array are returned as leftovers.
folding
Source effect/Sink.ts:79812 lines
export const const foldUntil: <
S,
In,
E = never,
R = never
>(
s: LazyArg<S>,
max: number,
f: (s: S, input: In) => Effect.Effect<S, E, R>
) => Sink<S, In, In, E, R>
Folds input elements into state until the specified maximum number of
elements has been consumed or the upstream stream ends.
Details
If the sink stops in the middle of a pulled array, the remaining elements
from that array are returned as leftovers.
foldUntil = <function (type parameter) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S, function (type parameter) In in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>In, function (type parameter) E in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>E = never, function (type parameter) R in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>R = never>(
s: LazyArg<S>s: type LazyArg<A> = () => AA zero-argument function that produces a value when invoked.
When to use
Use to type a lazy value provider that should not run until called.
Example (Creating a lazy argument)
import { Function } from "effect"
const constNull: Function.LazyArg<null> = Function.constant(null)
LazyArg<function (type parameter) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S>,
max: numbermax: number,
f: (
s: S,
input: In
) => Effect.Effect<S, E, R>
s: Ss: function (type parameter) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S, input: Ininput: function (type parameter) In in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>In) => import EffectEffect.interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<function (type parameter) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S, function (type parameter) E in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>E, function (type parameter) R in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, 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) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S, function (type parameter) In in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>In, function (type parameter) In in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>In, function (type parameter) E in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>E, function (type parameter) R in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>R> =>
const fold: <S, In, E = never, R = never>(
s: LazyArg<S>,
contFn: Predicate<S>,
f: (s: S, input: In) => Effect.Effect<S, E, R>
) => Sink<S, In, In, E, R>
A sink that folds its inputs with the provided function, termination
predicate and initial state.
When to use
Use to accumulate stream input element by element with an effectful step and
stop based on the accumulated state.
Details
The initial state is evaluated lazily. Each input element is folded with the
effectful function, and the sink continues while contFn returns true. If
the sink stops in the middle of a pulled array, the remaining elements from
that array are returned as leftovers.
fold<readonly [function (type parameter) S in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>S, number], function (type parameter) In in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>In, function (type parameter) E in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>E, function (type parameter) R in <S, In, E = never, R = never>(s: LazyArg<S>, max: number, f: (s: S, input: In) => Effect.Effect<S, E, R>): Sink<S, In, In, E, R>R>(
() => [s: LazyArg<S>s(), 0],
(tuple: readonly [S, number](parameter) tuple: {
0: S;
1: number;
length: 2;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<number | S>>): Array<number | S>; (...items: Array<number | S | ConcatArray<number | S>>): Array<number | S> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<number | S>;
indexOf: (searchElement: number | S, fromIndex?: number) => number;
lastIndexOf: (searchElement: number | S, fromIndex?: number) => number;
every: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: …;
some: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => void, thisArg?: any) => void;
map: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): Array<S>; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): Array<…;
reduce: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
reduceRight: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
find: { (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any): numbe…;
findIndex: (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, number | S]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<number | S>;
includes: (searchElement: number | S, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: number | S, index: number, array: Array<number | S>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => number | S | undefined;
findLast: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): n…;
findLastIndex: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
toReversed: () => Array<number | S>;
toSorted: (compareFn?: ((a: number | S, b: number | S) => number) | undefined) => Array<number | S>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<number | S>): Array<number | S>; (start: number, deleteCount?: number): Array<number | S> };
with: (index: number, value: number | S) => Array<number | S>;
}
tuple: readonly [S, number](parameter) tuple: {
0: S;
1: number;
length: 2;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<number | S>>): Array<number | S>; (...items: Array<number | S | ConcatArray<number | S>>): Array<number | S> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<number | S>;
indexOf: (searchElement: number | S, fromIndex?: number) => number;
lastIndexOf: (searchElement: number | S, fromIndex?: number) => number;
every: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: …;
some: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => void, thisArg?: any) => void;
map: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): Array<S>; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): Array<…;
reduce: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
reduceRight: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
find: { (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any): numbe…;
findIndex: (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, number | S]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<number | S>;
includes: (searchElement: number | S, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: number | S, index: number, array: Array<number | S>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => number | S | undefined;
findLast: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): n…;
findLastIndex: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
toReversed: () => Array<number | S>;
toSorted: (compareFn?: ((a: number | S, b: number | S) => number) | undefined) => Array<number | S>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<number | S>): Array<number | S>; (start: number, deleteCount?: number): Array<number | S> };
with: (index: number, value: number | S) => Array<number | S>;
}
max: numbermax,
([output: Soutput, count: numbercount], input: Ininput) => import EffectEffect.const map: {
<A, B>(f: (a: A) => B): <E, R>(
self: Effect<A, E, R>
) => Effect<B, E, R>
<A, E, R, B>(
self: Effect<A, E, R>,
f: (a: A) => B
): Effect<B, E, R>
}
f: (
s: S,
input: In
) => Effect.Effect<S, E, R>
output: Soutput, input: Ininput), (s: Ss) => [s: Ss, count: numbercount + 1] as type const = readonly [S, number]const)
).Pipeable.pipe<Sink<readonly [S, number], In, In, E, R>, Sink<S, In, In, E, R>>(this: Sink<readonly [S, number], In, In, E, R>, ab: (_: Sink<readonly [S, number], In, In, E, R>) => Sink<S, In, In, E, R>): Sink<S, In, In, E, R> (+21 overloads)pipe(
const map: {
<A, A2>(f: (a: A) => A2): <In, L, E, R>(
self: Sink<A, In, L, E, R>
) => Sink<A2, In, L, E, R>
<A, In, L, E, R, A2>(
self: Sink<A, In, L, E, R>,
f: (a: A) => A2
): Sink<A2, In, L, E, R>
}
tuple: readonly [S, number](parameter) tuple: {
0: S;
1: number;
length: 2;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<number | S>>): Array<number | S>; (...items: Array<number | S | ConcatArray<number | S>>): Array<number | S> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<number | S>;
indexOf: (searchElement: number | S, fromIndex?: number) => number;
lastIndexOf: (searchElement: number | S, fromIndex?: number) => number;
every: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: …;
some: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => void, thisArg?: any) => void;
map: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): Array<S>; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): Array<…;
reduce: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
reduceRight: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
find: { (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any): numbe…;
findIndex: (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, number | S]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<number | S>;
includes: (searchElement: number | S, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: number | S, index: number, array: Array<number | S>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => number | S | undefined;
findLast: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): n…;
findLastIndex: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
toReversed: () => Array<number | S>;
toSorted: (compareFn?: ((a: number | S, b: number | S) => number) | undefined) => Array<number | S>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<number | S>): Array<number | S>; (start: number, deleteCount?: number): Array<number | S> };
with: (index: number, value: number | S) => Array<number | S>;
}
tuple: readonly [S, number](parameter) tuple: {
0: S;
1: number;
length: 2;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<number | S>>): Array<number | S>; (...items: Array<number | S | ConcatArray<number | S>>): Array<number | S> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<number | S>;
indexOf: (searchElement: number | S, fromIndex?: number) => number;
lastIndexOf: (searchElement: number | S, fromIndex?: number) => number;
every: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: …;
some: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => void, thisArg?: any) => void;
map: (callbackfn: (value: number | S, index: number, array: ReadonlyArray<number | S>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): Array<S>; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): Array<…;
reduce: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
reduceRight: { (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: number, array: ReadonlyArray<number | S>) => number | S): number | S; (callbackfn: (previousValue: number | S, currentValue: number | S, currentIndex: numbe…;
find: { (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any): numbe…;
findIndex: (predicate: (value: number | S, index: number, obj: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, number | S]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<number | S>;
includes: (searchElement: number | S, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: number | S, index: number, array: Array<number | S>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => number | S | undefined;
findLast: { (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => value is S, thisArg?: any): S | undefined; (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any): n…;
findLastIndex: (predicate: (value: number | S, index: number, array: ReadonlyArray<number | S>) => unknown, thisArg?: any) => number;
toReversed: () => Array<number | S>;
toSorted: (compareFn?: ((a: number | S, b: number | S) => number) | undefined) => Array<number | S>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<number | S>): Array<number | S>; (start: number, deleteCount?: number): Array<number | S> };
with: (index: number, value: number | S) => Array<number | S>;
}