Class Or<T0, T1>

constructor

• new Or<T0, T1>(value0, value1): Or<T0, T1>

• Type Parameters

  • T0 extends TypeInformation<any, any, T0>

  • T1 extends TypeInformation<any, any, T1>

  Parameters

  • value0: T0

  • value1: T1

  Returns Or<T0, T1>

Readonly value0

Readonly value1

identifier

• get identifier(): string

• Returns string

check

• check<T>(value): Extends<T, T0 | T1>

• Checks if the given value is of the type defined by this type information

  Type Parameters

  • T

  Parameters

  • value: T

    The value to check

  Returns Extends<T, T0 | T1>

checkError

• checkError(value): undefined | string

• Returns the check-error for the given value

  Parameters

  • value: unknown

    The value to check

  Returns undefined | string

  The error if the value is not of the type defined by this type information

exportToJson

• exportToJson(_value): JsonCompatible

• Parameters

  • _value: PrimitiveType<T0> | PrimitiveType<T1>

  Returns JsonCompatible

exportToString

• exportToString(_value): string

• Parameters

  • _value: PrimitiveType<T0> | PrimitiveType<T1>

  Returns string

importFromJson

• importFromJson(_value): PrimitiveType<T0> | PrimitiveType<T1>

• Parameters

  • _value: JsonCompatible

  Returns PrimitiveType<T0> | PrimitiveType<T1>

importFromString

• importFromString(_value): PrimitiveType<T0> | PrimitiveType<T1>

• Parameters

  • _value: string

  Returns PrimitiveType<T0> | PrimitiveType<T1>

json

• json(): {
      type: string;
      value0: unknown;
      value1: unknown;
  }

• Returns {
      type: string;
      value0: unknown;
      value1: unknown;
  }

  • type: string

  • value0: unknown

  • value1: unknown

sendableVia

• sendableVia(): SendMethod[]

• Get a list of methods that can be used to send this type to the server

  Returns SendMethod[]
• sendableVia(m): boolean

• Checks if the given method can be used to send this type to the server

  Parameters

  • m: SendMethod

    The method to check

  Returns boolean

toString

• toString(): string

• Returns string