Defined in: validation.public.ts:711
Values and helpers passed to a form validation function.
Type Parameters#
TFormData#
TFormData
Library-managed. Do not specify explicitly.
Properties#
createErrorMap#
createErrorMap: (initial?) => ValidationErrorMap<TFormData>;
Defined in: validation.public.ts:725
Creates an error map with field paths inferred from the form values.
Creates a mutable map of form errors and errors for individual field paths.
Pass the completed map back from a form or group validator to report the errors.
Parameters#
initial?#
Partial<ValidationErrorMap<TFormData>>
An existing map to reuse. A missing fields object is added to it.
Returns#
ValidationErrorMap<TFormData>
The initial map, if supplied, or a new map with an empty fields object.
createOutput#
createOutput: CreateOutputFn;
Defined in: validation.public.ts:727
Creates a successful result to return data in this validator's validatorOutputs entry.
event#
event: ValidationTrigger | "server";
Defined in: validation.public.ts:713
The event that caused this validation run.
formApi#
formApi: FormApi<TFormData, any> | undefined;
Defined in: validation.public.ts:717
The owning form on the client. undefined during server validation.
parseIssues#
parseIssues: ParseFormIssuesFn<TFormData>;
Defined in: validation.public.ts:723
Converts Standard Schema issues into form and field errors to return from this validator.
signal#
signal: AbortSignal;
Defined in: validation.public.ts:715
Aborted when this run is cancelled. Pass it to asynchronous work such as fetch.
triggerFieldApi?#
optional triggerFieldApi?: AnyFieldApi;
Defined in: validation.public.ts:719
The field that caused validation, when available.
value#
value: TFormData;
Defined in: validation.public.ts:721
The complete form values being validated.