Interface IValidationContainerContext<TValue, TRawValue>

Represents the context for validation execution within the container.

interface IValidationContainerContext<TValue, TRawValue = TValue> {
    cancellationToken: null | CancellationToken;
    handled: boolean;
    rawValue: TRawValue;
    validationResult: IValidationResultBuilder;
    validationResultInfo:
        | null
        | Partial<
            Pick<
                IValidationResultItem,
                "key"
                | "fieldName"
                | "objectName"
                | "objectType",
            >,
        >;
    value: TValue;
    addError(value: Omit<ValidationContainerResultItem, "type">): void;
    addInfo(value: Omit<ValidationContainerResultItem, "type">): void;
    addResult(value: ValidationResult | ValidationContainerResultItem): void;
    addWarning(value: Omit<ValidationContainerResultItem, "type">): void;
}

Type Parameters

TValue
Type of the resulting value for validation.
TRawValue = TValue
Type of the raw value for validation. Defaults to TValue.

Index

Properties

cancellationToken handled rawValue validationResult validationResultInfo value

Methods

addError addInfo addResult addWarning

Properties

`Readonly`cancellationToken

cancellationToken: null | CancellationToken

An object through which an asynchronous operation can be canceled.

handled

handled: boolean

Indicates whether the validation result has been processed.

`Readonly`rawValue

rawValue: TRawValue

The raw value for validation.

`Readonly`validationResult

validationResult: IValidationResultBuilder

Builder for creating validation results.

`Readonly`validationResultInfo

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

Additional information about validation of the object.

`Readonly`value

value: TValue

The value to be validated.

Methods

addError

addError(value: Omit<ValidationContainerResultItem, "type">): void
Adds a validation result value to the validationResult in the context with ValidationResultType.Error type.
Parameters
- value: Omit<ValidationContainerResultItem, "type">
  The value to be added to the validation result.
Returns void
Remarks
- The added value will be modified by incorporating additional information from the validationResultInfo object, if such information is provided.
- The handled property will automatically be set to true.
- Defined in @tessa/ui/src/common/validation/validationContainerTypes.ts:80

addInfo

addInfo(value: Omit<ValidationContainerResultItem, "type">): void
Adds a validation result value to the validationResult in the context with ValidationResultType.Info type.
Parameters
- value: Omit<ValidationContainerResultItem, "type">
  The value to be added to the validation result.
Returns void
Remarks
The added value will be modified by incorporating additional information from the validationResultInfo object, if such information is provided.
- Defined in @tessa/ui/src/common/validation/validationContainerTypes.ts:62

addResult

addResult(value: ValidationResult | ValidationContainerResultItem): void
Adds a validation result value to the validationResult in the context.
Parameters
- value: ValidationResult | ValidationContainerResultItem
  The value to be added to the validation result.
Returns void
Remarks
- The added value will be modified by incorporating additional information from the validationResultInfo object, if such information is provided.
- If the added value contains at least one item of error type ValidationResultType.Error, the handled property will automatically be set to true.
- Defined in @tessa/ui/src/common/validation/validationContainerTypes.ts:90

addWarning

addWarning(value: Omit<ValidationContainerResultItem, "type">): void
Adds a validation result value to the validationResult in the context with ValidationResultType.Warning type.
Parameters
- value: Omit<ValidationContainerResultItem, "type">
  The value to be added to the validation result.
Returns void
Remarks
The added value will be modified by incorporating additional information from the validationResultInfo object, if such information is provided.
- Defined in @tessa/ui/src/common/validation/validationContainerTypes.ts:70