Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FormGroupValidatorContext.md

142 lines3.2 KB

Defined in: validation.public.ts:867

Values and helpers passed to a form group validation function.

Type Parameters

TGroupValue

TGroupValue

Library-managed. Do not specify explicitly.

Properties

createErrorMap

createErrorMap: (initial?) => ValidationErrorMap<TGroupValue>;

Defined in: validation.public.ts:883

Creates an error map whose field paths are relative to this group.

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<TGroupValue>>

An existing map to reuse. A missing fields object is added to it.

Returns

ValidationErrorMap<TGroupValue>

The initial map, if supplied, or a new map with an empty fields object.


createOutput

createOutput: CreateOutputFn;

Defined in: validation.public.ts:885

Creates a successful result to return data in this validator's validatorOutputs entry.


event

event: ValidationTrigger;

Defined in: validation.public.ts:869

The event that caused this validation run.


formApi

formApi: FormApi<any, any>;

Defined in: validation.public.ts:873

The owning form, including values outside this group.


groupApi

groupApi: FormGroupApi<any, any, TGroupValue, any, any>;

Defined in: validation.public.ts:875

The group whose value is being validated.


parseIssues

parseIssues: ParseFormIssuesFn<TGroupValue>;

Defined in: validation.public.ts:881

Converts Standard Schema issues into group errors and errors at group-relative field paths.


signal

signal: AbortSignal;

Defined in: validation.public.ts:871

Aborted when this run is cancelled. Pass it to asynchronous work such as fetch.


triggerFieldApi?

optional triggerFieldApi?: AnyFieldApi;

Defined in: validation.public.ts:877

The field that caused validation, when available.


value

value: TGroupValue;

Defined in: validation.public.ts:879

The group's current value, without the surrounding form values.