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:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L331)
9β
10An object type representing the options for a field in a form.
11β
12## Extends
13β
14- `FieldExtraOptions`\<`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## Properties
67β
68### asyncAlways?
69β
70```ts
71optional asyncAlways: boolean;
72```
73β
74Defined in: [packages/form-core/src/types.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L982)
75β
76If `true`, always run async validation, even if there are errors emitted during synchronous validation.
77β
78#### Inherited from
79β
80```ts
81FieldLikeOptions.asyncAlways
82```
83β
84***
85β
86### asyncDebounceMs?
87β
88```ts
89optional asyncDebounceMs: number;
90```
91β
92Defined in: [packages/form-core/src/types.ts:978](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L978)
93β
94The default time to debounce async validation if there is not a more specific debounce time passed.
95β
96#### Inherited from
97β
98```ts
99FieldLikeOptions.asyncDebounceMs
100```
101β
102***
103β
104### defaultMeta?
105β
106```ts
107optional defaultMeta: Partial<FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
108```
109β
110Defined in: [packages/form-core/src/types.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L986)
111β
112An optional object with default metadata for the field.
113β
114#### Inherited from
115β
116```ts
117FieldLikeOptions.defaultMeta
118```
119β
120***
121β
122### defaultValue?
123β
124```ts
125optional defaultValue: NoInfer<TData>;
126```
127β
128Defined in: [packages/form-core/src/types.ts:974](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L974)
129β
130An optional default value for the field.
131β
132#### Inherited from
133β
134```ts
135FieldLikeOptions.defaultValue
136```
137β
138***
139β
140### disableErrorFlat?
141β
142```ts
143optional disableErrorFlat: boolean;
144```
145β
146Defined in: [packages/form-core/src/types.ts:1014](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L1014)
147β
148Disable 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.
149β
150#### Inherited from
151β
152```ts
153FieldLikeOptions.disableErrorFlat
154```
155β
156***
157β
158### listeners?
159β
160```ts
161optional listeners: FieldListeners<TParentData, TName, TData>;
162```
163β
164Defined in: [packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L325)
165β
166A list of listeners which attach to the corresponding events
167β
168#### Inherited from
169β
170```ts
171FieldExtraOptions.listeners
172```
173β
174***
175β
176### name
177β
178```ts
179name: TName;
180```
181β
182Defined in: [packages/form-core/src/types.ts:970](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L970)
183β
184The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
185β
186#### Inherited from
187β
188```ts
189FieldLikeOptions.name
190```
191β
192***
193β
194### validators?
195β
196```ts
197optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
198```
199β
200Defined in: [packages/form-core/src/FieldApi.ts:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307)
201β
202A list of validators to pass to the field
203β
204#### Inherited from
205β
206```ts
207FieldExtraOptions.validators
208```