UNPKG

type-fest

Version:

A collection of essential TypeScript types

30 lines (21 loc) • 765 B
/** Returns a boolean for whether the given type includes `undefined`. Note: `any` returns `true`; `never`, `unknown`, and `void` return `false`. Unions are normalized before checking for an `undefined` member, rather than merely accepting an `undefined` value. @example ```ts import type {IsOptional} from 'type-fest'; type A = IsOptional<string>; //=> false type B = IsOptional<string | undefined>; //=> true type C = IsOptional<string | null>; //=> false type D = IsOptional<string | null | undefined>; //=> true ``` @category Type Guard @category Utilities */ // Extraction yields `undefined`, `never`, or `any`; only the first and last include `undefined`. export type IsOptional<T> = undefined extends Extract<T, undefined> ? true : false; export {};