ts-toolbelt/out/Object/P/Record.d.ts

TypeScript's largest utility library

import { Modx } from '../_Internal';
import { IterationOf } from '../../Iteration/IterationOf';
import { Iteration } from '../../Iteration/Iteration';
import { Pos } from '../../Iteration/Pos';
import { Next } from '../../Iteration/Next';
import { Key } from '../../Any/Key';
import { LastKey } from '../../List/LastKey';
import { List } from '../../List/List';
/**
 * @hidden
 */
declare type Record_RR<Path extends List<Key>, A, I extends Iteration = IterationOf<0>> = {
    readonly [Key in Path[Pos<I>]]: Pos<I> extends LastKey<Path> ? A : Record_RR<Path, A, Next<I>>;
} & {};
/**
 * @hidden
 */
export declare type Record_RW<Path extends List<Key>, A, I extends Iteration = IterationOf<0>> = {
    [Key in Path[Pos<I>]]: Pos<I> extends LastKey<Path> ? A : Record_RW<Path, A, Next<I>>;
} & {};
/**
 * @hidden
 */
declare type Record_OR<Path extends List<Key>, A, I extends Iteration = IterationOf<0>> = {
    readonly [Key in Path[Pos<I>]]?: Pos<I> extends LastKey<Path> ? A : Record_OR<Path, A, Next<I>>;
} & {};
/**
 * @hidden
 */
declare type Record_OW<Path extends List<Key>, A, I extends Iteration = IterationOf<0>> = {
    [Key in Path[Pos<I>]]?: Pos<I> extends LastKey<Path> ? A : Record_OW<Path, A, Next<I>>;
} & {};
/**
 * Create an object filled with `A` for the fields at the end of `Path`
 * @param Path to choose fields
 * @param A to fill fields with
 * @param modx (?=`['!', 'W']`) to set modifiers
 * @returns [[Object]]
 * @example
 * ```ts
 * ```
 */
export declare type Record<Path extends List<Key>, A, modx extends Modx = ['!', 'W']> = {
    '!': {
        'R': Record_RR<Path, A>;
        'W': Record_RW<Path, A>;
    };
    '?': {
        'R': Record_OR<Path, A>;
        'W': Record_OW<Path, A>;
    };
}[modx[0]][modx[1]];
export {};