Options
All
  • Public
  • Public/Protected
  • All
Menu

A skeleton class used to create CustomTypes. Defined as a class, instead of an interface, to allow the use of
private and protected values as needed.

Hierarchy

Index

Methods

Static getClassType

  • getClassType(): string
  • Method that returns the type as a string for a CustomType.

    static

    Returns string

    The class' type as a string.

Static isEqual

  • Checks if two CustomTypes are equal to each other or not.

    static

    Parameters

    • customType1: CustomType

      The first CustomType to check with.

    • customType2: CustomType

      The second CustomType to check with.

    Returns boolean

    True if the CustomTypes are equal, otherwise false.

Static isStrictEqual

  • Strictly checks if two CustomTypes are equal to each other or not.

    static

    Parameters

    • customType1: CustomType

      The first CustomType to check with.

    • customType2: CustomType

      The second CustomType to check with.

    Returns boolean

    True if the CustomTypes are strict equal, otherwise false.

Static toString

  • toString(): string

getCode

  • getCode(): string

getText

  • getText(): string

getType

  • getType(): string

isEqual

  • Checks if a CustomType is equal to a provided CustomType.

    Parameters

    • customType: CustomType

      The CustomType to compare.

    Returns boolean

    True if the provided CustomType is equal to the current CustomType, otherwise false.

isStrictEqual

  • Strictly checks if a CustomType is equal to a provided CustomType.

    Parameters

    • customType: CustomType

      The CustomType to compare.

    Returns boolean

    True if the provided CustomType is strict equal to the current CustomType, otherwise false.

isValid

  • isValid(): (string | boolean)[]
  • Validation method for the CustomType class. Ensures that a CustomType is built correctly.

    Returns (string | boolean)[]

    An array with a true/false value indicating if the CustomType is valid
    or not, and either an empty string when valid, or a string containing the error message when invalid.

toString

  • toString(): string

Properties

Static Protected TYPE

TYPE: string = "CustomType"

Variable used to hold the type information for the CustomType class, which is used to build the CustomType's
representation when converted to a string.

static

Protected code

code: string

The code for the CustomType. Required.

Protected text

text: string

The text readable value for the CustomType. Required.

Protected type

type: string

The CustomType defined as a string value. Required.

Constructors

constructor

  • new CustomType(code: string, text: string, type: string): CustomType
  • Creates an instance of a CustomType.

    Parameters

    • code: string

      The code for the CustomType.

    • text: string

      The readable value of the CustomType.

    • type: string

      The CustomType's type value as a string.

    Returns CustomType

Generated using TypeDoc