Open History to see the last commit
1---
2id: FieldOptions
3title: FieldOptions
4---
5β
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7β
8# Interface: FieldOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync\>
9β
10Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L390)
11β
12An object type representing the options for a field in a form.
13β
14## Extended by
15β
16- [`FieldApiOptions`](../fieldapioptions.md)
17β
18## Type Parameters
19β
20β’ **TParentData**
21β
22β’ **TName** *extends* [`DeepKeys`](../../type-aliases/deepkeys.md)\<`TParentData`\>
23β
24β’ **TData** *extends* [`DeepValue`](../../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>
25β
26β’ **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
27β
28β’ **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
29β
30β’ **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31β
32β’ **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33β
34β’ **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35β
36β’ **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37β
38β’ **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39β
40β’ **TOnDynamic** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
41β
42β’ **TOnDynamicAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43β
44## Properties
45β
46### asyncAlways?
47β
48```ts
49optional asyncAlways: boolean;
50```
51β
52Defined in: [packages/form-core/src/FieldApi.ts:427](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L427)
53β
54If `true`, always run async validation, even if there are errors emitted during synchronous validation.
55β
56***
57β
58### asyncDebounceMs?
59β
60```ts
61optional asyncDebounceMs: number;
62```
63β
64Defined in: [packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L423)
65β
66The default time to debounce async validation if there is not a more specific debounce time passed.
67β
68***
69β
70### defaultMeta?
71β
72```ts
73optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
74```
75β
76Defined in: [packages/form-core/src/FieldApi.ts:448](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L448)
77β
78An optional object with default metadata for the field.
79β
80***
81β
82### defaultValue?
83β
84```ts
85optional defaultValue: NoInfer<TData>;
86```
87β
88Defined in: [packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L419)
89β
90An optional default value for the field.
91β
92***
93β
94### disableErrorFlat?
95β
96```ts
97optional disableErrorFlat: boolean;
98```
99β
100Defined in: [packages/form-core/src/FieldApi.ts:480](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L480)
101β
102Disable 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.
103β
104***
105β
106### listeners?
107β
108```ts
109optional listeners: FieldListeners<TParentData, TName, TData>;
110```
111β
112Defined in: [packages/form-core/src/FieldApi.ts:476](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L476)
113β
114A list of listeners which attach to the corresponding events
115β
116***
117β
118### name
119β
120```ts
121name: TName;
122```
123β
124Defined in: [packages/form-core/src/FieldApi.ts:415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L415)
125β
126The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
127β
128***
129β
130### validators?
131β
132```ts
133optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
134```
135β
136Defined in: [packages/form-core/src/FieldApi.ts:431](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L431)
137β
138A list of validators to pass to the field