Interface Validator<Options, Mixin>

The validator to which the field value validation is delegated.

interface Validator<
    Options = void,
    Mixin extends object = ValidationMixin<Options>,
> {
    validate(field: Field<any, Mixin>, options: Options): void;
    validateAsync(field: Field<any, Mixin>, options: Options): Promise<void>;
}

Type Parameters

Options = void
Options passed to the validator.
Mixin extends object = ValidationMixin<Options>
The mixin added to the field.

Index

Methods

validate? validateAsync?

Methods

`Optional`validate

validate(field: Field<any, Mixin>, options: Options): void
Applies validation rules to a field.

Before marking the field as invalid, check that the validation didn't change.
Parameters
- field: Field<any, Mixin>
  The field where ValidationMixin.validate was called.
- options: Options
  The options passed to the ValidationMixin.validate method.
Returns void

`Optional`validateAsync

validateAsync(field: Field<any, Mixin>, options: Options): Promise<void>
Applies validation rules to a field. If this callback is omitted, then Validator.validate would be called instead.

Before marking the field as invalid, check that the validation didn't change, and wasn't aborted.
Parameters
- field: Field<any, Mixin>
  The field where ValidationMixin.validateAsync was called.
- options: Options
  The options passed to the ValidationMixin.validateAsync method.
Returns Promise<void>