type-fest/source/is-unknown.d.ts

44 lines
785 B
TypeScript

import type {IsNull} from './is-null.d.ts';
/**
Returns a boolean for whether the given type is `unknown`.
@link https://github.com/dsherret/conditional-type-checks/pull/16
Useful in type utilities, such as when dealing with unknown data from API calls.
@example
```
import type {IsUnknown} from 'type-fest';
type A = IsUnknown<unknown>;
//=> unknown
type B = IsUnknown<any>;
//=> false
type C = IsUnknown<never>;
//=> false
type D = IsUnknown<unknown[]>;
//=> false
type E = IsUnknown<object>;
//=> false
type F = IsUnknown<string>;
//=> false
```
@category Utilities
*/
export type IsUnknown<T> = (
unknown extends T // `T` can be `unknown` or `any`
? IsNull<T> extends false // `any` can be `null`, but `unknown` can't be
? true
: false
: false
);
export {};