veffect
Version:
powerful TypeScript validation library built on the robust foundation of Effect combining exceptional type safety, high performance, and developer experience. Taking inspiration from Effect's functional principles, VEffect delivers a balanced approach tha
87 lines • 2.88 kB
TypeScript
import type { Pipeable } from "./Pipeable.js";
import type { Predicate } from "./Predicate.js";
import type * as Queue from "./Queue.js";
import type * as Stream from "./Stream.js";
import type * as Take from "./Take.js";
import type { Covariant, NoInfer } from "./Types.js";
/**
* @since 2.0.0
* @category symbols
*/
export declare const GroupByTypeId: unique symbol;
/**
* @since 2.0.0
* @category symbols
*/
export type GroupByTypeId = typeof GroupByTypeId;
/**
* Representation of a grouped stream. This allows to filter which groups will
* be processed. Once this is applied all groups will be processed in parallel
* and the results will be merged in arbitrary order.
*
* @since 2.0.0
* @category models
*/
export interface GroupBy<out K, out V, out E = never, out R = never> extends GroupBy.Variance<K, V, E, R>, Pipeable {
readonly grouped: Stream.Stream<readonly [K, Queue.Dequeue<Take.Take<V, E>>], E, R>;
}
/**
* @since 2.0.0
*/
export declare namespace GroupBy {
/**
* @since 2.0.0
* @category models
*/
interface Variance<out K, out V, out E, out R> {
readonly [GroupByTypeId]: {
readonly _K: Covariant<K>;
readonly _V: Covariant<V>;
readonly _E: Covariant<E>;
readonly _R: Covariant<R>;
};
}
}
/**
* Run the function across all groups, collecting the results in an
* arbitrary order.
*
* @since 2.0.0
* @category destructors
*/
export declare const evaluate: {
<K, V, E, A, E2, R2>(f: (key: K, stream: Stream.Stream<V, E, never>) => Stream.Stream<A, E2, R2>, options?: {
readonly bufferSize?: number | undefined;
} | undefined): <R>(self: GroupBy<K, V, E, R>) => Stream.Stream<A, E | E2, R2 | R>;
<K, V, E, R, A, E2, R2>(self: GroupBy<K, V, E, R>, f: (key: K, stream: Stream.Stream<V, E, never>) => Stream.Stream<A, E2, R2>, options?: {
readonly bufferSize?: number | undefined;
} | undefined): Stream.Stream<A, E | E2, R | R2>;
};
/**
* Filter the groups to be processed.
*
* @since 2.0.0
* @category utils
*/
export declare const filter: {
<K>(predicate: Predicate<NoInfer<K>>): <V, E, R>(self: GroupBy<K, V, E, R>) => GroupBy<K, V, E, R>;
<K, V, E, R>(self: GroupBy<K, V, E, R>, predicate: Predicate<K>): GroupBy<K, V, E, R>;
};
/**
* Only consider the first `n` groups found in the `Stream`.
*
* @since 2.0.0
* @category utils
*/
export declare const first: {
(n: number): <K, V, E, R>(self: GroupBy<K, V, E, R>) => GroupBy<K, V, E, R>;
<K, V, E, R>(self: GroupBy<K, V, E, R>, n: number): GroupBy<K, V, E, R>;
};
/**
* Constructs a `GroupBy` from a `Stream`.
*
* @since 2.0.0
* @category constructors
*/
export declare const make: <K, V, E, R>(grouped: Stream.Stream<readonly [K, Queue.Dequeue<Take.Take<V, E>>], E, R>) => GroupBy<K, V, E, R>;
//# sourceMappingURL=GroupBy.d.ts.map