ts-toolbelt/out/Object/Compulsory.d.ts

TypeScript's largest utility library

import { _Pick } from './Pick';
import { Depth } from './_Internal';
import { Key } from '../Any/Key';
import { NonNullable } from '../Union/NonNullable';
import { PatchFlat } from './Patch';
import { BuiltIn } from '../Misc/BuiltIn';
/**
 * @hidden
 */
export declare type CompulsoryFlat<O> = {
    [K in keyof O]-?: NonNullable<O[K]>;
} & {};
/**
 * @hidden
 */
export declare type CompulsoryDeep<O> = {
    [K in keyof O]-?: O[K] extends BuiltIn ? O[K] : CompulsoryDeep<NonNullable<O[K]>>;
};
/**
 * @hidden
 */
export declare type CompulsoryPart<O extends object, depth extends Depth> = {
    'flat': CompulsoryFlat<O>;
    'deep': CompulsoryDeep<O>;
}[depth];
/**
 * @hidden
 */
export declare type _Compulsory<O extends object, K extends Key, depth extends Depth> = PatchFlat<CompulsoryPart<_Pick<O, K>, depth>, O>;
/**
 * Make that `O`'s fields cannot be [[Nullable]] or [[Optional]] (it's like
 * [[Required]] & [[NonNullable]] at once).
 * @param O to make compulsory
 * @param K (?=`Key`) to choose fields
 * @param depth (?=`'flat'`) 'deep' to do it deeply
 * @returns [[Object]]
 * @example
 * ```ts
 * ```
 */
export declare type Compulsory<O extends object, K extends Key = Key, depth extends Depth = 'flat'> = O extends unknown ? _Compulsory<O, K, depth> : never;