Validation message.

Hierarchy

  • ValidationResultItem

Implements

Constructors

  • Creates an instance of the class with the text and message type that occurred during validation.

    Parameters

    • params: {
          details?: string;
          fieldName?: string;
          key: ValidationKey;
          message: string;
          objectName?: string;
          objectType?: string;
          type: ValidationResultType;
      }
      • Optional details?: string

        Additional information about the message, such as the full text of the exception, or '' if there is no additional information.

      • Optional fieldName?: string

        The name of the field of the object to which the validation message refers, or '' if the field is unknown.

      • key: ValidationKey

        The key of the message that occurred during validation.

      • message: string

        The text of the message that occurred during validation.

      • Optional objectName?: string

        The name of the object to which the validation message refers, or '' if the name is unknown.

      • Optional objectType?: string

        The type of the object to which the validation message refers, or '' if the type is unknown.

      • type: ValidationResultType

        The type of message that occurred during validation.

    Returns ValidationResultItem

Properties

details: string

Additional information about the message, such as the full text of the exception, or '' if there is no additional information.

fieldName: string

The name of the field of the object to which the validation message refers, or '' if the field is unknown.

The key of the message that occurred during validation.

message: string

The text of the message that occurred during validation.

objectName: string

The name of the object to which the validation message refers, or '' if the name is unknown.

objectType: string

The type of the object to which the validation message refers, or '' if the type is unknown.

The type of message that occurred during validation.

Accessors

Methods

  • Returns a text representation for the validation message with the specified output mode.

    Returns

    The text representation for the validation message.

    Parameters

    • level: ValidationLevel = ValidationLevel.General

      Text output mode as a result of validation.

    Returns string

Generated using TypeDoc