Class ObjectTypeInformation<T>

constructor

• new ObjectTypeInformation<T>(properties): ObjectTypeInformation<T>

• Type Parameters

  • T extends {
        [key: string]: {
            required: boolean;
            type: AllowAnyTypeInformation;
        };
    }

  Parameters

  • properties: T

  Returns ObjectTypeInformation<T>

Readonly properties

identifier

• get identifier(): string

• Returns string

allOptional

• allOptional(): ObjectTypeInformation<{
      [key in string | number | symbol]: {
          required: false;
          type: T[key]["type"];
      }
  }>

• Create a type information for this object with all properties optional

  Returns ObjectTypeInformation<{
      [key in string | number | symbol]: {
          required: false;
          type: T[key]["type"];
      }
  }>

  A type information for this object with all properties optional

allRequired

• allRequired(): ObjectTypeInformation<{
      [key in string | number | symbol]: {
          required: true;
          type: T[key]["type"];
      }
  }>

• Create a type information for this object with all properties required

  Returns ObjectTypeInformation<{
      [key in string | number | symbol]: {
          required: true;
          type: T[key]["type"];
      }
  }>

  A type information for this object with all properties required

check

• check<U>(value): Extends<U, ObjectType<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, ObjectType<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: ObjectType<T>

  Returns JsonCompatible

exportToString

• exportToString(value): string

• Parameters

  • value: ObjectType<T>

  Returns string

importFromJson

• importFromJson(value): ObjectType<T>

• Parameters

  • value: JsonCompatible

  Returns ObjectType<T>

importFromString

• importFromString(value): ObjectType<T>

• Parameters

  • value: string

  Returns ObjectType<T>

json

• json(): {
      properties: {
          [k: string]: T;
      };
      type: string;
  }

• Returns {
      properties: {
          [k: string]: T;
      };
      type: string;
  }

  • properties: {
        [k: string]: T;
    }

    • [k: string]: T

  • type: string

keys

• keys(): (keyof T)[]

• Get keys of this object

  Returns (keyof T)[]

  Keys of this object

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