Open History to see the last commit
1---
2id: FormGroupValidatorContext
3title: FormGroupValidatorContext
4---
5β
6Defined in: [validation.public.ts:867](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L867)
7β
8Values and helpers passed to a form group validation function.
9β
10## Type Parameters
11β
12### TGroupValue
13β
14`TGroupValue`
15β
16Library-managed. Do not specify explicitly.
17β
18## Properties
19β
20### createErrorMap
21β
22```ts
23createErrorMap: (initial?) => ValidationErrorMap<TGroupValue>;
24```
25β
26Defined in: [validation.public.ts:883](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L883)
27β
28Creates an error map whose field paths are relative to this group.
29β
30Creates a mutable map of form errors and errors for individual field paths.
31β
32Pass the completed map back from a form or group validator to report the errors.
33β
34#### Parameters
35β
36##### initial?
37β
38`Partial`\<[`ValidationErrorMap`](ValidationErrorMap.md)\<`TGroupValue`\>\>
39β
40An existing map to reuse. A missing `fields` object is added to it.
41β
42#### Returns
43β
44[`ValidationErrorMap`](ValidationErrorMap.md)\<`TGroupValue`\>
45β
46The initial map, if supplied, or a new map with an empty `fields` object.
47β
48***
49β
50### createOutput
51β
52```ts
53createOutput: CreateOutputFn;
54```
55β
56Defined in: [validation.public.ts:885](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L885)
57β
58Creates a successful result to return data in this validator's `validatorOutputs` entry.
59β
60***
61β
62### event
63β
64```ts
65event: ValidationTrigger;
66```
67β
68Defined in: [validation.public.ts:869](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L869)
69β
70The event that caused this validation run.
71β
72***
73β
74### formApi
75β
76```ts
77formApi: FormApi<any, any>;
78```
79β
80Defined in: [validation.public.ts:873](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L873)
81β
82The owning form, including values outside this group.
83β
84***
85β
86### groupApi
87β
88```ts
89groupApi: FormGroupApi<any, any, TGroupValue, any, any>;
90```
91β
92Defined in: [validation.public.ts:875](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L875)
93β
94The group whose value is being validated.
95β
96***
97β
98### parseIssues
99β
100```ts
101parseIssues: ParseFormIssuesFn<TGroupValue>;
102```
103β
104Defined in: [validation.public.ts:881](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L881)
105β
106Converts Standard Schema issues into group errors and errors at group-relative field paths.
107β
108***
109β
110### signal
111β
112```ts
113signal: AbortSignal;
114```
115β
116Defined in: [validation.public.ts:871](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L871)
117β
118Aborted when this run is cancelled. Pass it to asynchronous work such as `fetch`.
119β
120***
121β
122### triggerFieldApi?
123β
124```ts
125optional triggerFieldApi?: AnyFieldApi;
126```
127β
128Defined in: [validation.public.ts:877](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L877)
129β
130The field that caused validation, when available.
131β
132***
133β
134### value
135β
136```ts
137value: TGroupValue;
138```
139β
140Defined in: [validation.public.ts:879](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L879)
141β
142The group's current value, without the surrounding form values.