Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

fieldapioptions.md

180 lines4.3 KB

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:311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L311)
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:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307)
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:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L329)
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:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L303)
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:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362)
109​
110***
111​
112### listeners?
113​
114```ts
115optional listeners: FieldListeners<TParentData, TName, TFieldValidator, TFormValidator, TData>;
116```
117​
118A list of listeners which attach to the corresponding events
119​
120#### Inherited from
121​
122[`FieldOptions`](fieldoptions.md).[`listeners`](FieldOptions.md#listeners)
123​
124#### Defined in
125​
126[packages/form-core/src/FieldApi.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L333)
127​
128***
129​
130### name
131​
132```ts
133name: TName;
134```
135​
136The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
137​
138#### Inherited from
139​
140[`FieldOptions`](fieldoptions.md).[`name`](FieldOptions.md#name)
141​
142#### Defined in
143​
144[packages/form-core/src/FieldApi.ts:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L299)
145​
146***
147​
148### validatorAdapter?
149​
150```ts
151optional validatorAdapter: TFieldValidator;
152```
153​
154A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter`
155​
156#### Inherited from
157​
158[`FieldOptions`](fieldoptions.md).[`validatorAdapter`](FieldOptions.md#validatoradapter)
159​
160#### Defined in
161​
162[packages/form-core/src/FieldApi.ts:315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L315)
163​
164***
165​
166### validators?
167​
168```ts
169optional validators: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;
170```
171​
172A list of validators to pass to the field
173​
174#### Inherited from
175​
176[`FieldOptions`](fieldoptions.md).[`validators`](FieldOptions.md#validators)
177​
178#### Defined in
179​
180[packages/form-core/src/FieldApi.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L319)