@@ -7,7 +7,7 @@ title: FieldApi
77
88# Class: FieldApi\< TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta\>
99
10- Defined in: [ packages/form-core/src/FieldApi.ts:859 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859 )
10+ Defined in: [ packages/form-core/src/FieldApi.ts:863 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863 )
1111
1212A class representing the API for managing a form field.
1313
@@ -65,7 +65,7 @@ the `new FieldApi` constructor.
6565new FieldApi <TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TParentSubmitMeta >(opts ): FieldApi < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TParentSubmitMeta >
6666```
6767
68- Defined in: [ packages/form-core/src/FieldApi.ts:973 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L973 )
68+ Defined in: [ packages/form-core/src/FieldApi.ts:977 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L977 )
6969
7070Initializes a new ` FieldApi ` instance.
7171
@@ -87,7 +87,7 @@ Initializes a new `FieldApi` instance.
8787form : FormApi < TParentData , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TParentSubmitMeta > ;
8888```
8989
90- Defined in: [ packages/form-core/src/FieldApi.ts:889 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L889 )
90+ Defined in: [ packages/form-core/src/FieldApi.ts:893 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L893 )
9191
9292A reference to the form API instance.
9393
@@ -99,7 +99,7 @@ A reference to the form API instance.
9999name : unknown extends TParentData ? string : TParentData extends readonly any [] & IsTuple < TParentData > ? PrefixTupleAccessor < TParentData < TParentData > , AllowedIndexes < TParentData < TParentData > , never > , []> : TParentData extends any [] ? PrefixArrayAccessor < TParentData < TParentData > , [any ]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor < TParentData < TParentData > , []> : TParentData extends string | number | bigint | boolean ? " " : never ;
100100```
101101
102- Defined in: [ packages/form-core/src/FieldApi.ts:913 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L913 )
102+ Defined in: [ packages/form-core/src/FieldApi.ts:917 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L917 )
103103
104104The field name.
105105
@@ -111,7 +111,7 @@ The field name.
111111options : FieldApiOptions < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TParentSubmitMeta > ;
112112```
113113
114- Defined in: [ packages/form-core/src/FieldApi.ts:917 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L917 )
114+ Defined in: [ packages/form-core/src/FieldApi.ts:921 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L921 )
115115
116116The field options.
117117
@@ -123,7 +123,7 @@ The field options.
123123store : Derived < FieldState < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync >> ;
124124```
125125
126- Defined in: [ packages/form-core/src/FieldApi.ts:941 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L941 )
126+ Defined in: [ packages/form-core/src/FieldApi.ts:945 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L945 )
127127
128128The field state store.
129129
@@ -135,7 +135,7 @@ The field state store.
135135timeoutIds : Record < ValidationCause , null | Timeout > ;
136136```
137137
138- Defined in: [ packages/form-core/src/FieldApi.ts:968 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L968 )
138+ Defined in: [ packages/form-core/src/FieldApi.ts:972 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L972 )
139139
140140## Accessors
141141
@@ -147,7 +147,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:968](https://github.com/TanStack
147147get state (): FieldState < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync >
148148```
149149
150- Defined in: [ packages/form-core/src/FieldApi.ts:965 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L965 )
150+ Defined in: [ packages/form-core/src/FieldApi.ts:969 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L969 )
151151
152152The current field state.
153153
@@ -163,7 +163,7 @@ The current field state.
163163getInfo (): FieldInfo < TParentData >
164164```
165165
166- Defined in: [ packages/form-core/src/FieldApi.ts:1221 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1221 )
166+ Defined in: [ packages/form-core/src/FieldApi.ts:1225 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1225 )
167167
168168Gets the field information object.
169169
@@ -179,7 +179,7 @@ Gets the field information object.
179179getMeta (): FieldMeta < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync >
180180```
181181
182- Defined in: [ packages/form-core/src/FieldApi.ts:1189 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1189 )
182+ Defined in: [ packages/form-core/src/FieldApi.ts:1193 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1193 )
183183
184184#### Returns
185185
@@ -193,7 +193,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1189](https://github.com/TanStac
193193getValue (): TData
194194```
195195
196- Defined in: [ packages/form-core/src/FieldApi.ts:1171 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1171 )
196+ Defined in: [ packages/form-core/src/FieldApi.ts:1175 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1175 )
197197
198198Gets the current field value.
199199
@@ -213,7 +213,7 @@ Use `field.state.value` instead.
213213handleBlur (): void
214214```
215215
216- Defined in: [ packages/form-core/src/FieldApi.ts:1593 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1593 )
216+ Defined in: [ packages/form-core/src/FieldApi.ts:1597 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1597 )
217217
218218Handles the blur event.
219219
@@ -229,7 +229,7 @@ Handles the blur event.
229229handleChange (updater ): void
230230```
231231
232- Defined in: [ packages/form-core/src/FieldApi.ts:1586 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1586 )
232+ Defined in: [ packages/form-core/src/FieldApi.ts:1590 ] ( https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1590 )
233233
234234Handles the change event.
235235
@@ -254,7 +254,7 @@ insertValue(
254254opts ? ): Promise < void >
255255` ` `
256256
257- Defined in: [packages/form-core/src/FieldApi.ts:1234 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1234 )
257+ Defined in: [packages/form-core/src/FieldApi.ts:1238 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1238 )
258258
259259Inserts a value at the specified index, shifting the subsequent values to the right.
260260
@@ -284,7 +284,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri
284284mount (): () => void
285285` ` `
286286
287- Defined in: [packages/form-core/src/FieldApi.ts:1077 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1077 )
287+ Defined in: [packages/form-core/src/FieldApi.ts:1081 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1081 )
288288
289289Mounts the field instance to the form.
290290
@@ -307,7 +307,7 @@ moveValue(
307307 opts ? ): void
308308` ` `
309309
310- Defined in: [packages/form-core/src/FieldApi.ts:1264 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1264 )
310+ Defined in: [packages/form-core/src/FieldApi.ts:1268 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1268 )
311311
312312Moves the value at the first specified index to the second specified index.
313313
@@ -337,7 +337,7 @@ Moves the value at the first specified index to the second specified index.
337337pushValue (value , opts ? ): void
338338` ` `
339339
340- Defined in: [packages/form-core/src/FieldApi.ts:1226 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1226 )
340+ Defined in: [packages/form-core/src/FieldApi.ts:1230 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1230 )
341341
342342Pushes a new value to the field.
343343
@@ -363,7 +363,7 @@ Pushes a new value to the field.
363363removeValue (index , opts ? ): Promise < void >
364364` ` `
365365
366- Defined in: [packages/form-core/src/FieldApi.ts:1252 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1252 )
366+ Defined in: [packages/form-core/src/FieldApi.ts:1256 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1256 )
367367
368368Removes a value at the specified index.
369369
@@ -392,7 +392,7 @@ replaceValue(
392392opts ? ): Promise < void >
393393` ` `
394394
395- Defined in: [packages/form-core/src/FieldApi.ts:1243 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1243 )
395+ Defined in: [packages/form-core/src/FieldApi.ts:1247 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1247 )
396396
397397Replaces a value at the specified index.
398398
@@ -422,7 +422,7 @@ Replaces a value at the specified index.
422422setErrorMap (errorMap ): void
423423` ` `
424424
425- Defined in: [packages/form-core/src/FieldApi.ts:1613 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1613 )
425+ Defined in: [packages/form-core/src/FieldApi.ts:1617 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617 )
426426
427427Updates the field's errorMap
428428
@@ -444,7 +444,7 @@ Updates the field's errorMap
444444setMeta (updater ): void
445445` ` `
446446
447- Defined in: [packages/form-core/src/FieldApi.ts:1194 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1194 )
447+ Defined in: [packages/form-core/src/FieldApi.ts:1198 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198 )
448448
449449Sets the field metadata.
450450
@@ -466,7 +466,7 @@ Sets the field metadata.
466466setValue (updater , options ? ): void
467467` ` `
468468
469- Defined in: [packages/form-core/src/FieldApi.ts:1178 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1178 )
469+ Defined in: [packages/form-core/src/FieldApi.ts:1182 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1182 )
470470
471471Sets the field value and run the ` change ` validator.
472472
@@ -495,7 +495,7 @@ swapValues(
495495 opts ? ): void
496496` ` `
497497
498- Defined in: [packages/form-core/src/FieldApi.ts:1258 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1258 )
498+ Defined in: [packages/form-core/src/FieldApi.ts:1262 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262 )
499499
500500Swaps the values at the specified indices.
501501
@@ -525,7 +525,7 @@ Swaps the values at the specified indices.
525525update (opts ): void
526526` ` `
527527
528- Defined in: [packages/form-core/src/FieldApi.ts:1119 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1119 )
528+ Defined in: [packages/form-core/src/FieldApi.ts:1123 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1123 )
529529
530530Updates the field instance with new options.
531531
@@ -547,7 +547,7 @@ Updates the field instance with new options.
547547validate (cause , opts ? ): unknown [] | Promise < unknown []>
548548` ` `
549549
550- Defined in: [packages/form-core/src/FieldApi.ts:1553 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1553 )
550+ Defined in: [packages/form-core/src/FieldApi.ts:1557 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1557 )
551551
552552Validates the field value.
553553
0 commit comments