Interface ValidationMixin<Result, Options>

The mixin added to fields by the validationPlugin.

interface ValidationMixin<Result, Options> {
    isValidating: boolean;
    validation: null | Validation<Result>;
    abortValidation(reason?: unknown): void;
    validate(options: Options): Result;
}

Type Parameters

Result
The result produced by a validator.
Options
Options passed to the validator.

Index

Properties

isValidating validation

Methods

abortValidation validate

Properties

`Readonly`isValidating

isValidating: boolean

true if the validation is pending, or false otherwise.

validation

validation: null | Validation<Result>

The pending validation, or null if there's no pending validation.

Methods

abortValidation

abortValidation(reason?: unknown): void
Aborts the validation associated with the field. No-op if there's no pending validation.
Parameters
- Optionalreason: unknown
Returns void

validate

validate(options: Options): Result
Validates the value of the field and values of its non-transient descendants.

If the field is already being validated, then the associated validation is aborted at the corresponding validation root.
Parameters
- options: Options
  Options passed to the validator.
Returns Result
The validation result.