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:383](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L383)
9β
10## Extends
11β
12- `FieldExtraOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>
13β
14## Type Parameters
15β
16### TParentData
17β
18`TParentData`
19β
20### TName
21β
22`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
23β
24### TData
25β
26`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\>
27β
28### TOnMount
29β
30`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31β
32### TOnChange
33β
34`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35β
36### TOnChangeAsync
37β
38`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39β
40### TOnBlur
41β
42`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43β
44### TOnBlurAsync
45β
46`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
47β
48### TOnSubmit
49β
50`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
51β
52### TOnSubmitAsync
53β
54`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
55β
56### TOnDynamic
57β
58`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
59β
60### TOnDynamicAsync
61β
62`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
63β
64### TFormOnMount
65β
66`TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
67β
68### TFormOnChange
69β
70`TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
71β
72### TFormOnChangeAsync
73β
74`TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
75β
76### TFormOnBlur
77β
78`TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
79β
80### TFormOnBlurAsync
81β
82`TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
83β
84### TFormOnSubmit
85β
86`TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
87β
88### TFormOnSubmitAsync
89β
90`TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
91β
92### TFormOnDynamic
93β
94`TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
95β
96### TFormOnDynamicAsync
97β
98`TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
99β
100### TFormOnServer
101β
102`TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
103β
104### TParentSubmitMeta
105β
106`TParentSubmitMeta`
107β
108## Properties
109β
110### asyncAlways?
111β
112```ts
113optional asyncAlways: boolean;
114```
115β
116Defined in: [packages/form-core/src/types.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L982)
117β
118If `true`, always run async validation, even if there are errors emitted during synchronous validation.
119β
120#### Inherited from
121β
122```ts
123FieldLikeApiOptions.asyncAlways
124```
125β
126***
127β
128### asyncDebounceMs?
129β
130```ts
131optional asyncDebounceMs: number;
132```
133β
134Defined in: [packages/form-core/src/types.ts:978](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L978)
135β
136The default time to debounce async validation if there is not a more specific debounce time passed.
137β
138#### Inherited from
139β
140```ts
141FieldLikeApiOptions.asyncDebounceMs
142```
143β
144***
145β
146### defaultMeta?
147β
148```ts
149optional defaultMeta: Partial<FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
150```
151β
152Defined in: [packages/form-core/src/types.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L986)
153β
154An optional object with default metadata for the field.
155β
156#### Inherited from
157β
158```ts
159FieldLikeApiOptions.defaultMeta
160```
161β
162***
163β
164### defaultValue?
165β
166```ts
167optional defaultValue: NoInfer<TData>;
168```
169β
170Defined in: [packages/form-core/src/types.ts:974](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L974)
171β
172An optional default value for the field.
173β
174#### Inherited from
175β
176```ts
177FieldLikeApiOptions.defaultValue
178```
179β
180***
181β
182### disableErrorFlat?
183β
184```ts
185optional disableErrorFlat: boolean;
186```
187β
188Defined in: [packages/form-core/src/types.ts:1014](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L1014)
189β
190Disable 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.
191β
192#### Inherited from
193β
194```ts
195FieldLikeApiOptions.disableErrorFlat
196```
197β
198***
199β
200### form
201β
202```ts
203form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
204```
205β
206Defined in: [packages/form-core/src/types.ts:1094](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L1094)
207β
208#### Inherited from
209β
210```ts
211FieldLikeApiOptions.form
212```
213β
214***
215β
216### listeners?
217β
218```ts
219optional listeners: FieldListeners<TParentData, TName, TData>;
220```
221β
222Defined in: [packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L325)
223β
224A list of listeners which attach to the corresponding events
225β
226#### Inherited from
227β
228```ts
229FieldExtraOptions.listeners
230```
231β
232***
233β
234### name
235β
236```ts
237name: TName;
238```
239β
240Defined in: [packages/form-core/src/types.ts:970](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L970)
241β
242The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
243β
244#### Inherited from
245β
246```ts
247FieldLikeApiOptions.name
248```
249β
250***
251β
252### validators?
253β
254```ts
255optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
256```
257β
258Defined in: [packages/form-core/src/FieldApi.ts:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307)
259β
260A list of validators to pass to the field
261β
262#### Inherited from
263β
264```ts
265FieldExtraOptions.validators
266```