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

FieldValidatorContext.md

100 lines2.1 KB

1---
2id: FieldValidatorContext
3title: FieldValidatorContext
4---
5​
6Defined in: [validation.public.ts:942](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L942)
7​
8Values and helpers passed to a field validation function.
9​
10## Type Parameters
11​
12### TFieldName
13​
14`TFieldName`
15​
16Library-managed. Do not specify explicitly.
17​
18### TFieldValue
19​
20`TFieldValue`
21​
22Library-managed. Do not specify explicitly.
23​
24### TFormData
25​
26`TFormData`
27​
28Library-managed. Do not specify explicitly.
29​
30## Properties
31​
32### event
33​
34```ts
35event: ValidationTrigger;
36```
37​
38Defined in: [validation.public.ts:948](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L948)
39​
40The event that caused this validation run.
41​
42***
43​
44### fieldApi
45​
46```ts
47fieldApi: FieldApi<TFieldName, TFieldValue, any, TFormData, any>;
48```
49​
50Defined in: [validation.public.ts:954](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L954)
51​
52The field being validated, including when a watched field caused the event.
53​
54***
55​
56### formApi
57​
58```ts
59formApi: FormApi<TFormData, any>;
60```
61​
62Defined in: [validation.public.ts:952](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L952)
63​
64The owning form. Read other field values here for cross-field validation.
65​
66***
67​
68### parseIssues
69​
70```ts
71parseIssues: ParseFieldIssuesFn;
72```
73​
74Defined in: [validation.public.ts:958](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L958)
75​
76Converts Standard Schema issues into errors for this field, without routing their paths.
77​
78***
79​
80### signal
81​
82```ts
83signal: AbortSignal;
84```
85​
86Defined in: [validation.public.ts:950](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L950)
87​
88Aborted when this run is cancelled. Pass it to asynchronous work such as `fetch`.
89​
90***
91​
92### value
93​
94```ts
95value: TFieldValue;
96```
97​
98Defined in: [validation.public.ts:956](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L956)
99​
100The current value of the field being validated.