Open History to see the last commit
1---
2id: FieldOptions
3title: FieldOptions
4---
5β
6# Interface: FieldOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync\>
7β
8Defined in: [packages/form-core/src/FieldApi.ts:392](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L392)
9β
10An object type representing the options for a field in a form.
11β
12## Extended by
13β
14- [`FieldApiOptions`](FieldApiOptions.md)
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## Properties
67β
68### asyncAlways?
69β
70```ts
71optional asyncAlways: boolean;
72```
73β
74Defined in: [packages/form-core/src/FieldApi.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L429)
75β
76If `true`, always run async validation, even if there are errors emitted during synchronous validation.
77β
78***
79β
80### asyncDebounceMs?
81β
82```ts
83optional asyncDebounceMs: number;
84```
85β
86Defined in: [packages/form-core/src/FieldApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L425)
87β
88The default time to debounce async validation if there is not a more specific debounce time passed.
89β
90***
91β
92### defaultMeta?
93β
94```ts
95optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
96```
97β
98Defined in: [packages/form-core/src/FieldApi.ts:450](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L450)
99β
100An optional object with default metadata for the field.
101β
102***
103β
104### defaultValue?
105β
106```ts
107optional defaultValue: NoInfer<TData>;
108```
109β
110Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L421)
111β
112An optional default value for the field.
113β
114***
115β
116### disableErrorFlat?
117β
118```ts
119optional disableErrorFlat: boolean;
120```
121β
122Defined in: [packages/form-core/src/FieldApi.ts:482](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L482)
123β
124Disable 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.
125β
126***
127β
128### listeners?
129β
130```ts
131optional listeners: FieldListeners<TParentData, TName, TData>;
132```
133β
134Defined in: [packages/form-core/src/FieldApi.ts:478](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L478)
135β
136A list of listeners which attach to the corresponding events
137β
138***
139β
140### name
141β
142```ts
143name: TName;
144```
145β
146Defined in: [packages/form-core/src/FieldApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417)
147β
148The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
149β
150***
151β
152### validators?
153β
154```ts
155optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
156```
157β
158Defined in: [packages/form-core/src/FieldApi.ts:433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L433)
159β
160A list of validators to pass to the field