Class ValidationContainer<TValue, TRawValue>

constructor

• new ValidationContainer<TValue, TRawValue = TValue>(
      getValue?: () => TValue,
      getRawValue?: () => TRawValue,
      _options?: ValidationContainerCreateOptions,
  ): ValidationContainer<TValue, TRawValue>

  Creates an instance of the ValidationContainer class.

  Type Parameters

  • TValue
  • TRawValue = TValue

  Parameters

  • OptionalgetValue: () => TValue

    Function to retrieve the resulting value for validation.

  • OptionalgetRawValue: () => TRawValue

    Function to retrieve the raw value for validation.

  • Optional_options: ValidationContainerCreateOptions

    Optional settings for creating the validation container.

  Returns ValidationContainer<TValue, TRawValue>

OptionalgetRawValue

OptionalgetValue

hasAsync

• get hasAsync(): boolean

  Indicates whether the validation container has validation function that runs asynchronously.

  Returns boolean

isEmpty

• get isEmpty(): boolean

  Indicates whether the validation container has no validators.

  Returns boolean

isEnabled

• get isEnabled(): boolean

  Indicates whether the validation container is enabled.

  Returns boolean

  Remarks

  The property only affects automatic validation when accessing the result property. In this case, validation can be performed by using validate or validateAsync methods.

  Default

  true
  Copy

• set isEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

isManual

• get isManual(): boolean

  Indicates whether the validation container work at manual mode. In manual mode, validation results are handled by the calling code.

  Returns boolean

  Remarks

  When accessing the result property, it will return value that was calculated at the time of the last validate or validateAsync methods call.

  Default

  false
  Copy

• set isManual(value: boolean): void

  Parameters

  • value: boolean

  Returns void

result

• get result(): ValidationResult

  Current validation result of value.

  Returns ValidationResult

  Remarks

  • If the isEnabled equals false, the result is an empty value.
  • If validation container works at manual mode (see. isManual), or has asynchronous validation function the result returned value that was calculated at the time of the last validate or validateAsync methods call.
• set result(value: null | ValidationResult): void

  Parameters

  • value: null | ValidationResult

  Returns void

resultDisplay

• get resultDisplay(): ValidationContainerResultDisplay

  Current validation result of value for displaying.

  Returns ValidationContainerResultDisplay

  Remarks

  The displayed value depends on the result and resultMode.

resultInfo

• get resultInfo(): | null
  | Partial<
      Pick<
          IValidationResultItem,
          "key"
          | "fieldName"
          | "objectName"
          | "objectType",
      >,
  >

  Additional information about validation of the object.

  Returns
      | null
      | Partial<
          Pick<
              IValidationResultItem,
              "key"
              | "fieldName"
              | "objectName"
              | "objectType",
          >,
      >

  Remarks

  This is optionally used to set additional information in the validator function when creating the validation result.

  Default

  null
  Copy

• set resultInfo(
      value:
          | null
          | Partial<
              Pick<
                  IValidationResultItem,
                  "key"
                  | "fieldName"
                  | "objectName"
                  | "objectType",
              >,
          >,
  ): void

  Parameters

  • value:
        | null
        | Partial<
            Pick<
                IValidationResultItem,
                "key"
                | "fieldName"
                | "objectName"
                | "objectType",
            >,
        >

  Returns void

resultMode

• get resultMode(): ValidationContainerResultMode

  The mode of displaying validation results.

  Returns ValidationContainerResultMode

  Default

  full
  Copy

• set resultMode(value: ValidationContainerResultMode): void

  Parameters

  • value: ValidationContainerResultMode

  Returns void

size

• get size(): number

  The number of validators in the container.

  Returns number

add

• add(
      validator: ValidationContainerValidator<TValue, TRawValue>,
      settings?: IValidationContainerValidatorSettings,
  ): boolean

  Adds a synchronous validator to the validation container.

  Parameters

  • validator: ValidationContainerValidator<TValue, TRawValue>

    The validator function to add.

  • Optionalsettings: IValidationContainerValidatorSettings

    Optional settings for the validator.

  Returns boolean

  true if the validator was added successfully, otherwise false.

addAsync

• addAsync(
      validator: ValidationContainerValidator<TValue, TRawValue>,
      settings?: IValidationContainerValidatorSettings,
  ): boolean

  Adds an asynchronous validator to the validation container.

  Parameters

  • validator: ValidationContainerValidator<TValue, TRawValue>

    The validator function to add.

  • Optionalsettings: IValidationContainerValidatorSettings

    Optional settings for the validator.

  Returns boolean

  true if the validator was added successfully, otherwise false.

clear

• clear(): void

  Clears all validators from the container.

  Returns void

dispose

• dispose(): void

  Returns void

has

• has(validator: ValidationContainerValidator<TValue, TRawValue>): boolean

  Checks if a specific validator function is present in the container.

  Parameters

  • validator: ValidationContainerValidator<TValue, TRawValue>

    The validator function to check.

  Returns boolean

  true if the validator function is present, otherwise false.

remove

• remove(validator: ValidationContainerValidator<TValue, TRawValue>): boolean

  Removes a specific validator function from the container.

  Parameters

  • validator: ValidationContainerValidator<TValue, TRawValue>

    The validator function to remove.

  Returns boolean

  true if the validator was removed successfully, otherwise false.

removeById

• removeById(id: string): boolean

  Removes all validator functions with a specific identifier from the container.

  Parameters

  • id: string

    The identifier of the validators to remove.

  Returns boolean

  true if any validators were removed, otherwise false.

  Remarks

  The search by identifier is case-insensitive.

validate

• validate(value: TValue, rawValue?: TRawValue): ValidationResult

  Validates a value using the container's only synchronous validators.

  Parameters

  • value: TValue

    The resulting value to validate.

  • OptionalrawValue: TRawValue

    The raw value to validate.

  Returns ValidationResult

  The validation result.

  Throws

  If the validation container contains an asynchronous validator.

validateAsync

• validateAsync(value: TValue, rawValue?: TRawValue): Promise<ValidationResult>

  Validates a value using the container's all validators.

  Parameters

  • value: TValue

    The resulting value to validate.

  • OptionalrawValue: TRawValue

    The raw value to validate.

  Returns Promise<ValidationResult>

  The validation result.