mirror of
https://github.com/sindresorhus/type-fest.git
synced 2025-12-08 19:25:05 +00:00
27 lines
587 B
TypeScript
27 lines
587 B
TypeScript
import type {IsNull} from './is-null.d.ts';
|
|
|
|
/**
|
|
An if-else-like type that resolves depending on whether the given type is `null`.
|
|
|
|
@deprecated This type will be removed in the next major version. Use the {@link If} type instead.
|
|
|
|
@see {@link IsNull}
|
|
|
|
@example
|
|
```
|
|
import type {IfNull} from 'type-fest';
|
|
|
|
type ShouldBeTrue = IfNull<null>;
|
|
//=> true
|
|
|
|
type ShouldBeBar = IfNull<'not null', 'foo', 'bar'>;
|
|
//=> 'bar'
|
|
```
|
|
|
|
@category Type Guard
|
|
@category Utilities
|
|
*/
|
|
export type IfNull<T, TypeIfNull = true, TypeIfNotNull = false> = (
|
|
IsNull<T> extends true ? TypeIfNull : TypeIfNotNull
|
|
);
|