LiteralType

source

Constructors

new LiteralType(value: string): LiteralTypesource

Properties

readonlycompareEquality: Functionsource

inherited from StringType.compareEquality

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

readonlycompareOrder: Functionsource

inherited from StringType.compareOrder

The function used to order two values of this type.

constructor: Ctorsource

inherited from StringType.constructor

readonlyhasPrimitiveUnderlyingType: truesource

inherited from StringType.hasPrimitiveUnderlyingType

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

readonlyparse: ParseFnsource

The function used to parse a value of this type.

readonlyserialise: Functionsource

inherited from StringType.serialise

The function used to serialise a value of this type.

readonlytypeConstructor: StringConstructorsource

inherited from StringType.typeConstructor

readonlyvalue: stringsource

Methods

Instance methods

toJsonSchema(): JSONSchema7source

Inherited methods

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

inherited from StringType.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(): LiteralTypesource

inherited from StringType.orNull

toString(): stringsource

inherited from StringType.toString