Defined in: FormApi/formSubmit.public.ts:116
Form values, validator outputs, and error helpers passed to onSubmit after submission validation succeeds.
TFormErrorTypes
Library-managed. Do not specify explicitly.
TFormData
Library-managed. Do not specify explicitly.
TValidatorOutputs extends readonly unknown[]
Library-managed. Do not specify explicitly.
createErrorMap: CreateSubmitErrorMapFn<TFormData>;Defined in: FormApi/formSubmit.public.ts:171
Builds a mutable submission error map from optional initial errors. Return the map to apply its form and field errors. An empty map indicates success.
createValidationError: CreateValidationErrorFn<TFormData>;Defined in: FormApi/formSubmit.public.ts:166
Creates a validation error recognized as a submission failure when returned from a submission handler. Creating the error alone does not update form or field validation state.
formApi: FormApi<TFormData, ScopedErrorTypes<never, never>>;Defined in: FormApi/formSubmit.public.ts:123
The form instance handling this submission.
parseIssues: ParseSubmitIssuesFn<TFormData>;Defined in: FormApi/formSubmit.public.ts:176
Converts Standard Schema issues into a mutable submission error map using the submitted values. Return the map to report its form and field errors.
validatorOutputs: TValidatorOutputs;Defined in: FormApi/formSubmit.public.ts:160
The validator outputs from this submission.
Standard Schemas provide their output data automatically. Callback validators must return a createOutput result to provide output data.
Outputs follow the same order as the validators array.
Skipped validators and successful returns without output contribute undefined.
Outputs from earlier change, blur, or mount validation are not reused.
formOptions({
defaultValues: { name: '' },
validators: [
{
run: ({ createOutput, value }) => {
return createOutput({ displayName: value.name.trim() })
},
},
{
// Schemas pass their output data by default.
run: mySchema,
},
],
onSubmit: ({ validatorOutputs }) => {
// Outputs follow the same order as the validators array.
const [customData, schemaOutput] = validatorOutputs
console.log(customData.displayName)
},
})value: TFormData;Defined in: FormApi/formSubmit.public.ts:121
The form values for this submission, without schema transformations applied.