Defined in: validation.public.ts:523
Extends#
Validator<TFormData, |FieldValidatorFn<TFormData,TFieldName,TFieldValue> |StandardSchemaV1<TFieldValue,any>,TFieldValue,ConfigurableValidationTrigger,"field">
Type Parameters#
TFormData#
TFormData
TFieldName#
TFieldName
TFieldValue#
TFieldValue
Properties#
bailIfInvalid?#
optional bailIfInvalid?: boolean;
Defined in: validation.public.ts:21
If true, this validator and all subsequent validators will be skipped if any previous validator has failed.
If false, validators run regardless of earlier validation results.
Default#
false
Inherited from#
run#
run:
| FieldValidatorFn<TFormData, TFieldName, TFieldValue>
| StandardSchemaV1<TFieldValue, any>;
Defined in: validation.public.ts:14
Inherited from#
runOnMount?#
optional runOnMount?: boolean;
Defined in: validation.public.ts:45
Whether this validator should be called once when the form is constructed.
Default#
false
Inherited from#
runOnSubmit?#
optional runOnSubmit?:
| boolean
| ValidationPredicateFn<TFormData, TFieldValue, "field">;
Defined in: validation.public.ts:38
TODO docs
Whether this validator should be called during a submission attempt.
Default#
true
Inherited from#
triggerDebounceMs?#
optional triggerDebounceMs?:
| number
| ValidationDebounceFn<TFormData, TFieldValue, "field">;
Defined in: validation.public.ts:52
The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately.
Default#
0
Inherited from#
triggers#
triggers: ValidationTriggerOption<TFormData, TFieldValue, ConfigurableValidationTrigger, "field">[];
Defined in: validation.public.ts:54
Inherited from#
watchFields?#
optional watchFields?: DeepKeys<TFormData>[];
Defined in: validation.public.ts:535