Class StringTypeInformation<T>

constructor

• new StringTypeInformation<T>(value): StringTypeInformation<T>

• Type Parameters

  • T extends string

  Parameters

  • value: T

  Returns StringTypeInformation<T>

Readonly value

identifier

• get identifier(): string

• Returns string

check

• check<U>(value): Extends<U, T>

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

  Type Parameters

  • U

  Parameters

  • value: U

    The value to check

  Returns Extends<U, T>

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: T

  Returns JsonCompatible

exportToString

• exportToString(value): string

• Parameters

  • value: T

  Returns string

importFromJson

• importFromJson(value): T

• Parameters

  • value: JsonCompatible

  Returns T

importFromString

• importFromString(value): T

• Parameters

  • value: string

  Returns T

json

• json(): {
      type: string;
      value: T;
  }

• Returns {
      type: string;
      value: T;
  }

  • type: string

  • value: T

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