UnionType

source

Constructors

new UnionType(variants: Record<string, Type>): UnionTypesource

Properties

readonlycompareEquality: Functionsource

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

readonlycompareOrder: OrdCompareFnsource

The function used to order two values of this type.

constructor: Ctorsource

inherited from Type.constructor

readonlyparse: ParseFnsource

The function used to parse a value of this type.

readonlyserialise: SerialiseFnsource

The function used to serialise a value of this type.

readonlytypeConstructor: undefinedsource

readonlyvariants: Record<string, Type>source

Methods

Instance methods

toJsonSchema(): JSONSchema7source

Inherited methods

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

inherited from Type.is

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(): UnionTypesource

inherited from Type.orNull

toString(): stringsource

inherited from Type.toString