@codibre/fluent-iterable/dist/types/function-types/to-object-chain-function.d.ts

Provides LINQ-like fluent api operations for iterables and async iterables (ES2018+).

import { AsyncReducer, ItemType, KeysOfType, Reducer } from '../base';
export type BaseChainKeyType = string | symbol | number;
export type ChainKeyType = BaseChainKeyType | Iterable<BaseChainKeyType>;
export type ToObjectChainFuncMap<T> = (x: T) => ChainKeyType;
export type ToObjectChainKey<T> = KeysOfType<T, ChainKeyType> | ToObjectChainFuncMap<T>;
export type Indexes = [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19,
    20,
    -1
];
export type ToObjectChainValueOf<V, K extends ToObjectChainKey<V>> = K extends ToObjectChainFuncMap<V> ? ReturnType<K> : K extends keyof V ? V[K] : never;
export type RecordChain<Arr extends Array<ToObjectChainKey<V>>, V, R = V[], Pos extends number = 0> = {
    done: R;
    any: any;
    recur: ToObjectChainValueOf<V, Arr[Pos]> extends BaseChainKeyType ? Record<ToObjectChainValueOf<V, Arr[Pos]>, RecordChain<Arr, V, R, Indexes[Pos]>> : ToObjectChainValueOf<V, Arr[Pos]> extends Iterable<BaseChainKeyType> ? Record<ItemType<ToObjectChainValueOf<V, Arr[Pos]>>, RecordChain<Arr, V, R, Indexes[Pos]>> : never;
}[Pos extends Arr['length'] ? 'done' : Pos extends -1 ? 'any' : 'recur'];
export interface ToObjectChainFunction<T> {
    /**
     * Creates an object chain with the values of the specified fields where the latest
     * value in the chain will be the iterable item itself. This is a resolving operation
     * @param keys The keys to be chained
     * @returns The object chain
     */
    <A extends Array<ToObjectChainKey<T>>>(...keys: A): RecordChain<A, T>;
}
export interface AsyncToObjectChainFunction<T> {
    /**
     * Creates an object chain with the values of the specified fields where the latest
     * value in the chain will be the iterable item itself. This is a resolving operation
     * @param keys The keys to be chained. It can be either property names or mapping functions
     * @returns The object chain
     */
    <A extends Array<ToObjectChainKey<T>>>(...keys: A): Promise<RecordChain<A, T>>;
}
export interface ToObjectChainReduceFunction<T> {
    /**
     * Creates an object chain with the values of the specified fields where the latest
     * value in the chain will be the iterable item itself. This is a resolving operation
     * @param initial An initializer function to define the base value for each leaf
     * @param reduce: A reduce function to accumulate the leaf value for each value that fits it
     * @param keys The keys to be chained. It can be either property names or mapping functions
     * @returns The object chain
     */
    <A extends Array<ToObjectChainKey<T>>, R>(initial: () => R, reduce: Reducer<T, R>, ...keys: A): RecordChain<A, T, R>;
}
export interface AsyncToObjectChainReduceFunction<T> {
    /**
     * Creates an object chain with the values of the specified fields where the latest
     * value in the chain will be the iterable item itself. This is a resolving operation
     * @param initial An initializer function to define the base value for each leaf
     * @param reduce: A reduce function to accumulate the leaf value for each value that fits it
     * @param keys The keys to be chained. It can be either property names or mapping functions
     * @returns The object chain
     */
    <A extends Array<ToObjectChainKey<T>>, R>(initial: () => R, reduce: AsyncReducer<T, R>, ...keys: A): Promise<RecordChain<A, T, R>>;
}