Class Type

Describes the type of a value.

Index

Properties

`Readonly`category

category: TypeCategory

`Readonly`name

name: null | string

`Optional` `Readonly`typeGuard

typeGuard?: (value: unknown) => boolean

`Static` `Readonly`ANONYMOUS_FUNCTION

ANONYMOUS_FUNCTION: Type = ...

An anonymous or arrow function.

`Static` `Readonly`ARRAY

ARRAY: Type = ...

`Static` `Readonly`BIGINT

BIGINT: Type = ...

`Static` `Readonly`BOOLEAN

BOOLEAN: Type = ...

`Static` `Readonly`NULL

NULL: Type = ...

`Static` `Readonly`NUMBER

NUMBER: Type = ...

`Static` `Readonly`STRING

STRING: Type = ...

`Static` `Readonly`SYMBOL

SYMBOL: Type = ...

`Static` `Readonly`UNDEFINED

UNDEFINED: Type = ...

Methods

equals

equals(other: Type): boolean
Indicates if this type is equal to another type.
Parameters
- other: Type
  another type
Returns boolean
true if this type matches other
- Defined in Type.mts:208

getTypeOf

getTypeOf(): Type
Returns the type of this type.

Returns Type
the type of this type
- Defined in Type.mts:219

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the type is an undefined, null, boolean, number, bigint, string or symbol value
- Defined in Type.mts:185

isSubtypeOf

isSubtypeOf(parent: Type): boolean
Indicates whether this type is a subtype of another type. Note that types are considered subtypes of themselves.
Parameters
- parent: Type
  the parent type
Returns boolean
- `true` if `child` extends `parent`
- `false` if `parent` or `child` are `undefined`, `null` or an object
- `false` if `child` does not extend `parent`
- Defined in Type.mts:250

toString

toString(): string
Returns string
the string representation of this object
- Defined in Type.mts:303

`Static`getPrimitive

getPrimitive(value: unknown): null | Type
Returns the type of an undefined, null, boolean, number, bigint, string or symbol value.
Parameters
- value: unknown
  a value
Returns null | Type
null if the value is not a primitive value
- Defined in Type.mts:136

`Static`namedClass

namedClass(name: null | string, typeGuard?: (value: unknown) => boolean): Type
Returns the type of a named class.
Parameters
- name: null | string
  the name of the class, or null to represent any class.
- OptionaltypeGuard: (value: unknown) => boolean
  (optional) for certain types, such as Typescript interfaces, runtime validation is not possible. In such a case, use a type guard to check if the value satisfies the type condition.
Returns Type
the type
- Defined in Type.mts:113

`Static`namedFunction

namedFunction(name: null | string): Type
Returns the type of a named function.
Parameters
- name: null | string
  (optional) the name of the function. name represents any named function.
Returns Type
the type
- Defined in Type.mts:124

`Static`of

of(value: unknown): Type
Returns the type of a value.
Parameters
- value: unknown
  a value
Returns Type
the value's type
See
- http://stackoverflow.com/a/332429/14731
- Type.isPrimitive
- Defined in Type.mts:52