Open History to see the last commit
1---
2id: FieldApiOptions
3title: FieldApiOptions
4---
5β
6# Interface: FieldApiOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta\>
7β
8Defined in: [packages/form-core/src/FieldApi.ts:488](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L488)
9β
10An object type representing the required options for the FieldApi class.
11β
12## Extends
13β
14- [`FieldOptions`](FieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>
15β
16## Type Parameters
17β
18### TParentData
19β
20`TParentData`
21β
22### TName
23β
24`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
25β
26### TData
27β
28`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\>
29β
30### TOnMount
31β
32`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33β
34### TOnChange
35β
36`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37β
38### TOnChangeAsync
39β
40`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
41β
42### TOnBlur
43β
44`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
45β
46### TOnBlurAsync
47β
48`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
49β
50### TOnSubmit
51β
52`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
53β
54### TOnSubmitAsync
55β
56`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
57β
58### TOnDynamic
59β
60`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
61β
62### TOnDynamicAsync
63β
64`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
65β
66### TFormOnMount
67β
68`TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
69β
70### TFormOnChange
71β
72`TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
73β
74### TFormOnChangeAsync
75β
76`TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
77β
78### TFormOnBlur
79β
80`TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
81β
82### TFormOnBlurAsync
83β
84`TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
85β
86### TFormOnSubmit
87β
88`TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
89β
90### TFormOnSubmitAsync
91β
92`TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
93β
94### TFormOnDynamic
95β
96`TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
97β
98### TFormOnDynamicAsync
99β
100`TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
101β
102### TFormOnServer
103β
104`TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
105β
106### TParentSubmitMeta
107β
108`TParentSubmitMeta`
109β
110## Properties
111β
112### asyncAlways?
113β
114```ts
115optional asyncAlways: boolean;
116```
117β
118Defined in: [packages/form-core/src/FieldApi.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L429)
119β
120If `true`, always run async validation, even if there are errors emitted during synchronous validation.
121β
122#### Inherited from
123β
124[`FieldOptions`](FieldOptions.md).[`asyncAlways`](FieldOptions.md#asyncalways)
125β
126***
127β
128### asyncDebounceMs?
129β
130```ts
131optional asyncDebounceMs: number;
132```
133β
134Defined in: [packages/form-core/src/FieldApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L425)
135β
136The default time to debounce async validation if there is not a more specific debounce time passed.
137β
138#### Inherited from
139β
140[`FieldOptions`](FieldOptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems)
141β
142***
143β
144### defaultMeta?
145β
146```ts
147optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
148```
149β
150Defined in: [packages/form-core/src/FieldApi.ts:450](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L450)
151β
152An optional object with default metadata for the field.
153β
154#### Inherited from
155β
156[`FieldOptions`](FieldOptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta)
157β
158***
159β
160### defaultValue?
161β
162```ts
163optional defaultValue: NoInfer<TData>;
164```
165β
166Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L421)
167β
168An optional default value for the field.
169β
170#### Inherited from
171β
172[`FieldOptions`](FieldOptions.md).[`defaultValue`](FieldOptions.md#defaultvalue)
173β
174***
175β
176### disableErrorFlat?
177β
178```ts
179optional disableErrorFlat: boolean;
180```
181β
182Defined in: [packages/form-core/src/FieldApi.ts:482](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L482)
183β
184Disable the `flat(1)` operation on `field.errors`. This is useful if you want to keep the error structure as is. Not suggested for most use-cases.
185β
186#### Inherited from
187β
188[`FieldOptions`](FieldOptions.md).[`disableErrorFlat`](FieldOptions.md#disableerrorflat)
189β
190***
191β
192### form
193β
194```ts
195form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
196```
197β
198Defined in: [packages/form-core/src/FieldApi.ts:552](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L552)
199β
200***
201β
202### listeners?
203β
204```ts
205optional listeners: FieldListeners<TParentData, TName, TData>;
206```
207β
208Defined in: [packages/form-core/src/FieldApi.ts:478](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L478)
209β
210A list of listeners which attach to the corresponding events
211β
212#### Inherited from
213β
214[`FieldOptions`](FieldOptions.md).[`listeners`](FieldOptions.md#listeners)
215β
216***
217β
218### name
219β
220```ts
221name: TName;
222```
223β
224Defined in: [packages/form-core/src/FieldApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417)
225β
226The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
227β
228#### Inherited from
229β
230[`FieldOptions`](FieldOptions.md).[`name`](FieldOptions.md#name)
231β
232***
233β
234### validators?
235β
236```ts
237optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
238```
239β
240Defined in: [packages/form-core/src/FieldApi.ts:433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L433)
241β
242A list of validators to pass to the field
243β
244#### Inherited from
245β
246[`FieldOptions`](FieldOptions.md).[`validators`](FieldOptions.md#validators)