Function isType

isType<T>(subject): subject is T
Is the subject of type T
Type Parameters
- T
Parameters
- subject: T
Returns subject is T
- Defined in packages/type-plus/src/type-guard/is_type.ts:6
isType<T>(subject, validator): subject is T
Is the subject of type T, satisfying the supplied validator
Type Parameters
- T
Parameters
- subject: unknown
- validator: ((s: T) => unknown)
  - - (s): unknown
    - Parameters
      s: T
      Returns unknown
Returns subject is T
- Defined in packages/type-plus/src/type-guard/is_type.ts:10

Index

Properties

Methods

Properties

never

never: {
<_S>(): unknown;
(subject: never): subject is never;
}

Type declaration

- <_S>(): unknown
- Check is the type never
  Type Parameters
  - _S extends never
  Returns unknown
  Deprecated
  use isType<T>() or testType.never<T>() instead
- (subject): subject is never
- Check is the value is type never
  Parameters
  - subject: never
  Returns subject is never
  Deprecated
  use isType<T>() or testType.never<T>() instead

Methods

equal

equal<_C, A, B>(): void
Are types A and B equals/not equals. Easier to use than isType.t<>() and isType.f<>(), when doing type level only equality comparison as you don't have to import Equal<>.
Type Parameters
- _C
- A
- B
Returns void
Deprecated
use testType.equal() instead
- Defined in packages/type-plus/src/type-guard/is_type.ts:48

f

f<T>(subject?): boolean
Type Parameters
- T extends false
Parameters
- Optionalsubject: T
Returns boolean
Deprecated
use isType<T>() or testType.false<T>() instead
- Defined in packages/type-plus/src/type-guard/is_type.ts:23

t

t<T>(subject?): boolean
Type Parameters
- T extends true
Parameters
- Optionalsubject: T
Returns boolean
Deprecated
use isType<T>() or testType.true<T>() instead
- Defined in packages/type-plus/src/type-guard/is_type.ts:18