Interface Validator<Options, Plugin>

The validator to which the field value validation is delegated.

interface Validator<Options, Plugin> {
validate?(field: Field<any, Plugin>, options: undefined | Options): void;
validateAsync?(field: Field<any, Plugin>, options: undefined | Options): Promise<void>;
}

Type Parameters

Options = any
Options passed to the validator.
Plugin = any
The plugin injected into the field.

Index

Methods

validate? validateAsync?

Methods

`Optional`validate

validate(field, 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, Plugin>
  The field where ValidationPlugin.validate was called.
- options: undefined | Options
  The options passed to the ValidationPlugin.validate method.
Returns void

`Optional`validateAsync

validateAsync(field, 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, Plugin>
  The field where ValidationPlugin.validateAsync was called.
- options: undefined | Options
  The options passed to the ValidationPlugin.validateAsync method.
Returns Promise<void>