Sink<number, unknown, never, never, never>A sink that counts the number of elements fed to it.
When to use
Use to consume input and return only the number of elements received.
constructors
Source effect/Sink.ts:15251 lines
export const const count: Sink<number, unknown>const count: {
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 sink that counts the number of elements fed to it.
When to use
Use to consume input and return only the number of elements received.
count: 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<number, unknown> = const reduceArray: <S, In>(
initial: LazyArg<S>,
f: (s: S, input: NonEmptyReadonlyArray<In>) => S
) => Sink<S, In>
A sink that reduces its inputs using the provided function f starting from
the specified initial state.
reduceArray(() => 0, (s: numbers, arr: NonEmptyReadonlyArray<In>(parameter) arr: {
0: unknown;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<unknown>>): Array<unknown>; (...items: Array<unknown>): Array<unknown> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<unknown>;
indexOf: (searchElement: unknown, fromIndex?: number) => number;
lastIndexOf: (searchElement: unknown, fromIndex?: number) => number;
every: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): boolea…;
some: (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: unknown, index: number, array: ReadonlyArray<unknown>) => void, thisArg?: any) => void;
map: (callbackfn: (value: unknown, index: number, array: ReadonlyArray<unknown>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): Array<S>; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): Array<unknown> };
reduce: { (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArray<unknown>) => unknown): unknown; (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArr…;
reduceRight: { (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArray<unknown>) => unknown): unknown; (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArr…;
find: { (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => value is S, thisArg?: any): S | undefined; (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => unknown, thisArg?: any): unknown };
findIndex: (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, unknown]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<unknown>;
includes: (searchElement: unknown, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: unknown, index: number, array: Array<unknown>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => unknown;
findLast: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): S | undefined; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): unknown };
findLastIndex: (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any) => number;
toReversed: () => Array<unknown>;
toSorted: (compareFn?: ((a: unknown, b: unknown) => number) | undefined) => Array<unknown>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<unknown>): Array<unknown>; (start: number, deleteCount?: number): Array<unknown> };
with: (index: number, value: unknown) => Array<unknown>;
}
s: numbers + arr: NonEmptyReadonlyArray<In>(parameter) arr: {
0: unknown;
length: number;
toString: () => string;
toLocaleString: { (): string; (locales: string | string[], options?: Intl.NumberFormatOptions & Intl.DateTimeFormatOptions): string };
concat: { (...items: Array<ConcatArray<unknown>>): Array<unknown>; (...items: Array<unknown>): Array<unknown> };
join: (separator?: string) => string;
slice: (start?: number, end?: number) => Array<unknown>;
indexOf: (searchElement: unknown, fromIndex?: number) => number;
lastIndexOf: (searchElement: unknown, fromIndex?: number) => number;
every: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): boolea…;
some: (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any) => boolean;
forEach: (callbackfn: (value: unknown, index: number, array: ReadonlyArray<unknown>) => void, thisArg?: any) => void;
map: (callbackfn: (value: unknown, index: number, array: ReadonlyArray<unknown>) => U, thisArg?: any) => Array<U>;
filter: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): Array<S>; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): Array<unknown> };
reduce: { (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArray<unknown>) => unknown): unknown; (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArr…;
reduceRight: { (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArray<unknown>) => unknown): unknown; (callbackfn: (previousValue: unknown, currentValue: unknown, currentIndex: number, array: ReadonlyArr…;
find: { (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => value is S, thisArg?: any): S | undefined; (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => unknown, thisArg?: any): unknown };
findIndex: (predicate: (value: unknown, index: number, obj: ReadonlyArray<unknown>) => unknown, thisArg?: any) => number;
entries: () => ArrayIterator<[number, unknown]>;
keys: () => ArrayIterator<number>;
values: () => ArrayIterator<unknown>;
includes: (searchElement: unknown, fromIndex?: number) => boolean;
flatMap: (callback: (this: This, value: unknown, index: number, array: Array<unknown>) => U | ReadonlyArray<U>, thisArg?: This | undefined) => Array<U>;
flat: (this: A, depth?: D | undefined) => Array<FlatArray<A, D>>;
at: (index: number) => unknown;
findLast: { (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => value is S, thisArg?: any): S | undefined; (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any): unknown };
findLastIndex: (predicate: (value: unknown, index: number, array: ReadonlyArray<unknown>) => unknown, thisArg?: any) => number;
toReversed: () => Array<unknown>;
toSorted: (compareFn?: ((a: unknown, b: unknown) => number) | undefined) => Array<unknown>;
toSpliced: { (start: number, deleteCount: number, ...items: Array<unknown>): Array<unknown>; (start: number, deleteCount?: number): Array<unknown> };
with: (index: number, value: unknown) => Array<unknown>;
}