Class NumberRangeTypeInformation<MIN, MAX>

constructor

• new NumberRangeTypeInformation<MIN, MAX>(min, max): NumberRangeTypeInformation<MIN, MAX>

• Type Parameters

  • MIN extends number

  • MAX extends number

  Parameters

  • min: MIN

  • max: MAX

  Returns NumberRangeTypeInformation<MIN, MAX>

Readonly max

Readonly min

identifier

• get identifier(): string

• Returns string

check

• check<U>(value): Extends<U, Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>>

• 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, Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>>

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: Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

  Returns JsonCompatible

exportToString

• exportToString(value): string

• Parameters

  • value: Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

  Returns string

importFromJson

• importFromJson(value): Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

• Parameters

  • value: JsonCompatible

  Returns Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

importFromString

• importFromString(value): Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

• Parameters

  • value: string

  Returns Exclude<Enumerate<MAX, []>, Enumerate<MIN, []>>

includes

• includes(value): boolean

• Parameters

  • value: number

  Returns boolean

json

• json(): {
      max: MAX;
      min: MIN;
      type: string;
  }

• Returns {
      max: MAX;
      min: MIN;
      type: string;
  }

  • max: MAX

  • min: MIN

  • type: string

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