ts-toolbelt/out/Function/Curry.d.ts

TypeScript's largest utility library

import { Pos } from '../Iteration/Pos';
import { Concat } from '../List/Concat';
import { Length } from '../List/Length';
import { Next } from '../Iteration/Next';
import { Cast } from '../Any/Cast';
import { Parameters } from './Parameters';
import { Return } from './Return';
import { IterationOf } from '../Iteration/IterationOf';
import { Iteration } from '../Iteration/Iteration';
import { NonNullableFlat } from '../Object/NonNullable';
import { x } from '../Any/x';
import { List } from '../List/List';
import { Function } from './Function';
import { Extends } from '../Any/Extends';
import { Tail } from '../List/Tail';
import { RequiredKeys } from '../List/RequiredKeys';
/**
 * @hidden
 */
declare type _SplitParams<P extends List, PSplit extends List[] = [], PRest extends List = Tail<P>> = {
    0: P extends [...infer A, ...PRest] ? _SplitParams<Tail<P>, [...PSplit, A], Tail<PRest>> : never;
    1: PSplit;
    2: P[number][][];
}[number extends Length<P> ? 2 : P extends [] ? 1 : 0];
/**
 * Splits tuples to preserve their labels
 * @hidden
 */
declare type SplitParams<P extends List> = _SplitParams<P> extends infer X ? Cast<X, List[]> : never;
/**
 * @hidden
 */
declare type _JoinParams<PSplit extends List[], L extends List = []> = {
    0: _JoinParams<Tail<PSplit>, [...L, ...PSplit[0]]>;
    1: L;
    2: PSplit[number][];
}[number extends Length<PSplit> ? 2 : PSplit extends [] ? 1 : 0];
/**
 * Undoes the job of [[SplitParams]]
 * @hidden
 */
declare type JoinParams<P extends List[]> = _JoinParams<P> extends infer X ? Cast<X, List> : never;
/**
 * @hidden
 */
declare type GapOf<L1 extends List, L2 extends List[], LN extends List, I extends Iteration> = L1[Pos<I>] extends x ? Concat<LN, L2[Pos<I>]> : LN;
/**
 * @hidden
 */
declare type _GapsOf<L1 extends List, L2 extends List[], LN extends List = [], L2D extends List[] = L2, I extends Iteration = IterationOf<0>> = {
    0: _GapsOf<L1, L2, GapOf<L1, L2, LN, I>, Tail<L2D>, Next<I>>;
    1: Concat<LN, JoinParams<L2D>>;
}[Extends<Pos<I>, Length<L1>>];
/**
 * @hidden
 */
declare type GapsOf<L1 extends List, L2 extends List> = _GapsOf<L1, SplitParams<L2>> extends infer X ? Cast<X, List> : never;
/**
 * @hidden
 */
declare type Gaps<L extends List> = Cast<NonNullableFlat<{
    [K in keyof L]?: L[K] | x;
}>, List>;
/**
 * Curry a [[Function]]
 * @param F to curry
 * @returns [[Function]]
 * @example
 * ```ts
 * import {F} from 'ts-toolbelt'
 *
 * /// If you are looking for creating types for `curry`
 * /// It handles placeholders and variable arguments
 * declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
 * ```
 */
export declare type Curry<F extends Function> = <P extends Gaps<Parameters<F>>, G extends List = GapsOf<P, Parameters<F>>, R extends any = Return<F>>(...p: Gaps<Parameters<F>> | P) => RequiredKeys<G> extends never ? R : Curry<(...p: G) => R>;
export {};