Type Alias: HandleSubmitFn<TFormData>

type HandleSubmitFn<TFormData> = () => Promise<FormValidationError<TFormData>[]>;

Defined in: FormApi/FormApi.public.ts:577

Runs submission validation and submits current values when validation succeeds.

Registered fields are marked touched, field validators run before form validators, and onSubmit is awaited only when validation succeeds. Validation error results and errors returned by onSubmit through createValidationError are stored as error state. onSubmitInvalid is awaited after a failed attempt.

Calls made while an attempt is in progress return the same promise instead of starting another attempt.

Type Parameters

TFormData

Library-managed. Do not specify explicitly.

Returns

Promise<FormValidationError<TFormData>[]>

A promise resolving to the error results produced by field and form validation, plus any validation error returned by onSubmit through createValidationError. The array is empty if none are produced.