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

TypeScript's largest utility library

import { Depth } from './_Internal';
import { _Pick } from './Pick';
import { Key } from '../Any/Key';
import { PatchFlat } from './Patch';
import { BuiltIn } from '../Misc/BuiltIn';
/**
 * @hidden
 */
export declare type UndefinableFlat<O> = {
    [K in keyof O]: O[K] | undefined;
} & {};
/**
 * @hidden
 */
export declare type UndefinableDeep<O> = {
    [K in keyof O]: O[K] extends BuiltIn ? O[K] : UndefinableDeep<O[K] | undefined>;
};
/**
 * @hidden
 */
declare type UndefinablePart<O extends object, depth extends Depth> = {
    'flat': UndefinableFlat<O>;
    'deep': UndefinableDeep<O>;
}[depth];
/**
 * @hidden
 */
export declare type _Undefinable<O extends object, K extends Key, depth extends Depth> = PatchFlat<UndefinablePart<_Pick<O, K>, depth>, O>;
/**
 * Make some fields of `O` `undefined` (deeply or not)
 * @param O to make undefinable
 * @param K (?=`Key`) to choose fields
 * @param depth (?=`'flat'`) 'deep' to do it deeply
 * @returns [[Object]]
 * @example
 * ```ts
 * ```
 */
export declare type Undefinable<O extends object, K extends Key = Key, depth extends Depth = 'flat'> = O extends unknown ? _Undefinable<O, K, depth> : never;
export {};