Open History to see the last commit
1---
2id: FieldApiOptions
3title: FieldApiOptions
4---
5β
6# Interface: FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\>
7β
8An object type representing the required options for the FieldApi class.
9β
10## Extends
11β
12- [`FieldOptions`](fieldoptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
13β
14## Type Parameters
15β
16β’ **TParentData**
17β
18β’ **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\>
19β
20β’ **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
21β
22β’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
23β
24β’ **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>
25β
26## Properties
27β
28### asyncAlways?
29β
30```ts
31optional asyncAlways: boolean;
32```
33β
34If `true`, always run async validation, even if there are errors emitted during synchronous validation.
35β
36#### Inherited from
37β
38[`FieldOptions`](fieldoptions.md).[`asyncAlways`](FieldOptions.md#asyncalways)
39β
40#### Defined in
41β
42[packages/form-core/src/FieldApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L287)
43β
44***
45β
46### asyncDebounceMs?
47β
48```ts
49optional asyncDebounceMs: number;
50```
51β
52The default time to debounce async validation if there is not a more specific debounce time passed.
53β
54#### Inherited from
55β
56[`FieldOptions`](fieldoptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems)
57β
58#### Defined in
59β
60[packages/form-core/src/FieldApi.ts:283](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L283)
61β
62***
63β
64### defaultMeta?
65β
66```ts
67optional defaultMeta: Partial<FieldMeta>;
68```
69β
70An optional object with default metadata for the field.
71β
72#### Inherited from
73β
74[`FieldOptions`](fieldoptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta)
75β
76#### Defined in
77β
78[packages/form-core/src/FieldApi.ts:305](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L305)
79β
80***
81β
82### defaultValue?
83β
84```ts
85optional defaultValue: NoInfer<TData>;
86```
87β
88An optional default value for the field.
89β
90#### Inherited from
91β
92[`FieldOptions`](fieldoptions.md).[`defaultValue`](FieldOptions.md#defaultvalue)
93β
94#### Defined in
95β
96[packages/form-core/src/FieldApi.ts:279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L279)
97β
98***
99β
100### form
101β
102```ts
103form: FormApi<TParentData, TFormValidator>;
104```
105β
106#### Defined in
107β
108[packages/form-core/src/FieldApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L328)
109β
110***
111β
112### name
113β
114```ts
115name: TName;
116```
117β
118The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
119β
120#### Inherited from
121β
122[`FieldOptions`](fieldoptions.md).[`name`](FieldOptions.md#name)
123β
124#### Defined in
125β
126[packages/form-core/src/FieldApi.ts:275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L275)
127β
128***
129β
130### validatorAdapter?
131β
132```ts
133optional validatorAdapter: TFieldValidator;
134```
135β
136A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter`
137β
138#### Inherited from
139β
140[`FieldOptions`](fieldoptions.md).[`validatorAdapter`](FieldOptions.md#validatoradapter)
141β
142#### Defined in
143β
144[packages/form-core/src/FieldApi.ts:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L291)
145β
146***
147β
148### validators?
149β
150```ts
151optional validators: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;
152```
153β
154A list of validators to pass to the field
155β
156#### Inherited from
157β
158[`FieldOptions`](fieldoptions.md).[`validators`](FieldOptions.md#validators)
159β
160#### Defined in
161β
162[packages/form-core/src/FieldApi.ts:295](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L295)