UNPKG

type-fest

Version:

A collection of essential TypeScript types

32 lines (22 loc) • 793 B
/** Returns a boolean for whether the given type includes `null`. Returns `true` for `any` and `false` for `never`, `unknown`, and `void`. Unions are normalized before checking for a `null` member. Note: The built-in `NonNullable` type removes both `null` and `undefined`, which is not accurate for the name. @example ```ts import type {IsNullable} from 'type-fest'; type A = IsNullable<string>; //=> false type B = IsNullable<string | null>; //=> true type C = IsNullable<string | undefined>; //=> false type D = IsNullable<string | null | undefined>; //=> true ``` @category Type Guard @category Utilities */ // Extraction yields `null`, `never`, or `any`; only the first and last include `null`. export type IsNullable<T> = null extends Extract<T, null> ? true : false; export {};