Type

source

Constructors

new Type(): Type

Properties

abstractreadonlycompareEquality: EqCompareFnsource

The function used to compare two values of this type for equality.

abstractreadonlycompareOrder: OrdCompareFnsource

The function used to order two values of this type.

constructor: Ctorsource

abstractreadonlyhasPrimitiveUnderlyingType: booleansource

If set, this field may be treated as a primitive for the purposes of comparisons and hash lookups.

abstractreadonlyparse: ParseFnsource

The function used to parse a value of this type.

abstractreadonlyserialise: SerialiseFnsource

The function used to serialise a value of this type.

abstractreadonlytypeConstructor: Functionsource

Methods

Instance methods

is<T extends Type>(ctor: AbstractCtor): this is Tsource

Returns true if this is an instance of the given supertype. This is equivalent to an instanceof check, except that the check is performed by comparing constructors by name rather than identity. This works around a bundling issue where the same class can appear multiple times in an application. For more context, see:

https://gitlab.cartax.io/platform/meta/-/merge_requests/590
https://gitlab.cartax.io/platform/meta/-/merge_requests/1194

orNull(): Typesource

abstracttoJsonSchema(): JSONSchema7source

toString(): stringsource