UNPKG

type-fest

Version:

A collection of essential TypeScript types

87 lines (72 loc) • 2.34 kB
import type {IsArrayOfUnknownLength} from './internal/array.d.ts'; import type {SimplifyDeep} from './simplify-deep.d.ts'; // For `@link` /** Recursively simplifies a type while including and/or excluding certain types from being simplified. @example ``` import type {ConditionalSimplifyDeep} from 'type-fest'; type TypeA = { foo: { a: string; }; }; type TypeB = { foo: { b: string; }; }; type SimplifyDeepTypeAB = ConditionalSimplifyDeep<TypeA & TypeB, never, object>; //=> {foo: {a: string; b: string}} ``` @example ``` import type {ConditionalSimplifyDeep} from 'type-fest'; type SomeComplexType1 = { a1: string; b1: number; c1: boolean; }; type SomeComplexType2 = { a2: string; b2: number; c2: boolean; }; type TypeA = { foo: { a: string; complexType: SomeComplexType1; }; }; type TypeB = { foo: { b: string; complexType: SomeComplexType2; }; }; type SimplifyDeepTypeAB = ConditionalSimplifyDeep<TypeA & TypeB, SomeComplexType1 | SomeComplexType2, object>; //=> { // foo: { // a: string; // complexType: SomeComplexType1 & SomeComplexType2; // b: string; // }; // } ``` Known limitations: - The default `IncludeType` is `unknown`, so the recursion reaches everything, and a function or a built-in comes back as an object of its own members with `{}` types. A function is then not callable at all, and a `Date` is no longer a `Date`. `SimplifyDeep`, which this type generalises, keeps both. Pass them as the `ExcludeType` to keep them: `ConditionalSimplifyDeep<Settings, Date | Function>`. @see {@link SimplifyDeep} @category Object */ export type ConditionalSimplifyDeep<Type, ExcludeType = never, IncludeType = unknown> = Type extends ExcludeType ? Type : Type extends IncludeType ? Type extends readonly unknown[] ? IsArrayOfUnknownLength<Type> extends true // Direct array recursion keeps recursive element types lazy; tuples retain their homomorphic mapped shape. ? Type extends unknown[] ? Array<ConditionalSimplifyDeep<Type[number], ExcludeType, IncludeType>> : ReadonlyArray<ConditionalSimplifyDeep<Type[number], ExcludeType, IncludeType>> : {[TypeKey in keyof Type]: ConditionalSimplifyDeep<Type[TypeKey], ExcludeType, IncludeType>} : {[TypeKey in keyof Type]: ConditionalSimplifyDeep<Type[TypeKey], ExcludeType, IncludeType>} : Type; export {};