Open History to see the last commit
1---
2id: FieldApi
3title: FieldApi
4---
5β
6# Class: FieldApi\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta\>
7β
8Defined in: [packages/form-core/src/FieldApi.ts:520](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L520)
9β
10A class representing the API for managing a form field.
11β
12Normally, you will not need to create a new `FieldApi` instance directly.
13Instead, you will use a framework hook/function like `useField` or `createField`
14to create a new instance for you that uses your framework's reactivity model.
15However, if you need to create a new instance manually, you can do so by calling
16the `new FieldApi` constructor.
17β
18## Type Parameters
19β
20### TParentData
21β
22`TParentData`
23β
24### TName
25β
26`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
27β
28### TData
29β
30`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\>
31β
32### TOnMount
33β
34`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35β
36### TOnChange
37β
38`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39β
40### TOnChangeAsync
41β
42`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43β
44### TOnBlur
45β
46`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
47β
48### TOnBlurAsync
49β
50`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
51β
52### TOnSubmit
53β
54`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
55β
56### TOnSubmitAsync
57β
58`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
59β
60### TOnDynamic
61β
62`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
63β
64### TOnDynamicAsync
65β
66`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
67β
68### TFormOnMount
69β
70`TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
71β
72### TFormOnChange
73β
74`TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
75β
76### TFormOnChangeAsync
77β
78`TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
79β
80### TFormOnBlur
81β
82`TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
83β
84### TFormOnBlurAsync
85β
86`TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
87β
88### TFormOnSubmit
89β
90`TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
91β
92### TFormOnSubmitAsync
93β
94`TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
95β
96### TFormOnDynamic
97β
98`TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
99β
100### TFormOnDynamicAsync
101β
102`TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
103β
104### TFormOnServer
105β
106`TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
107β
108### TParentSubmitMeta
109β
110`TParentSubmitMeta`
111β
112## Constructors
113β
114### Constructor
115β
116```ts
117new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
118```
119β
120Defined in: [packages/form-core/src/FieldApi.ts:712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L712)
121β
122Initializes a new `FieldApi` instance.
123β
124#### Parameters
125β
126##### opts
127β
128[`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
129β
130#### Returns
131β
132`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
133β
134## Properties
135β
136### form
137β
138```ts
139form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
140```
141β
142Defined in: [packages/form-core/src/FieldApi.ts:612](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L612)
143β
144A reference to the form API instance.
145β
146#### Implementation of
147β
148```ts
149FieldLikeAPI.form
150```
151β
152***
153β
154### name
155β
156```ts
157name: TName;
158```
159β
160Defined in: [packages/form-core/src/FieldApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L640)
161β
162The field name.
163β
164#### Implementation of
165β
166```ts
167FieldLikeAPI.name
168```
169β
170***
171β
172### options
173β
174```ts
175options: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
176```
177β
178Defined in: [packages/form-core/src/FieldApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L644)
179β
180The field options.
181β
182#### Implementation of
183β
184```ts
185FieldLikeAPI.options
186```
187β
188***
189β
190### store
191β
192```ts
193store: ReadonlyStore<FieldLikeState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>;
194```
195β
196Defined in: [packages/form-core/src/FieldApi.ts:672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L672)
197β
198The field state store.
199β
200#### Implementation of
201β
202```ts
203FieldLikeAPI.store
204```
205β
206***
207β
208### timeoutIds
209β
210```ts
211timeoutIds: object;
212```
213β
214Defined in: [packages/form-core/src/FieldApi.ts:703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L703)
215β
216#### formListeners
217β
218```ts
219formListeners: Record<ListenerCause, ReturnType<typeof setTimeout> | null>;
220```
221β
222#### listeners
223β
224```ts
225listeners: Record<ListenerCause, ReturnType<typeof setTimeout> | null>;
226```
227β
228#### validations
229β
230```ts
231validations: Record<ValidationCause, ReturnType<typeof setTimeout> | null>;
232```
233β
234## Accessors
235β
236### state
237β
238#### Get Signature
239β
240```ts
241get state(): FieldLikeState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
242```
243β
244Defined in: [packages/form-core/src/FieldApi.ts:700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L700)
245β
246The current field state.
247β
248##### Returns
249β
250`FieldLikeState`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>
251β
252## Methods
253β
254### clearValues()
255β
256```ts
257clearValues(options?): void;
258```
259β
260Defined in: [packages/form-core/src/FieldApi.ts:1214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1214)
261β
262Clear all values from the array.
263β
264#### Parameters
265β
266##### options?
267β
268`UpdateMetaOptions`
269β
270#### Returns
271β
272`void`
273β
274***
275β
276### getInfo()
277β
278```ts
279getInfo(): FieldInfo<TParentData>;
280```
281β
282Defined in: [packages/form-core/src/FieldApi.ts:1100](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1100)
283β
284Gets the field information object.
285β
286#### Returns
287β
288`FieldInfo`\<`TParentData`\>
289β
290#### Implementation of
291β
292```ts
293FieldLikeAPI.getInfo
294```
295β
296***
297β
298### getMeta()
299β
300```ts
301getMeta(): FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
302```
303β
304Defined in: [packages/form-core/src/FieldApi.ts:1064](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1064)
305β
306#### Returns
307β
308`FieldLikeMeta`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>
309β
310#### Implementation of
311β
312```ts
313FieldLikeAPI.getMeta
314```
315β
316***
317β
318### ~~getValue()~~
319β
320```ts
321getValue(): TData;
322```
323β
324Defined in: [packages/form-core/src/FieldApi.ts:1041](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1041)
325β
326Gets the current field value.
327β
328#### Returns
329β
330`TData`
331β
332#### Deprecated
333β
334Use `field.state.value` instead.
335β
336***
337β
338### handleBlur()
339β
340```ts
341handleBlur(): void;
342```
343β
344Defined in: [packages/form-core/src/FieldApi.ts:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1739)
345β
346Handles the blur event.
347β
348#### Returns
349β
350`void`
351β
352***
353β
354### handleChange()
355β
356```ts
357handleChange(updater): void;
358```
359β
360Defined in: [packages/form-core/src/FieldApi.ts:1732](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1732)
361β
362Handles the change event.
363β
364#### Parameters
365β
366##### updater
367β
368[`Updater`](../type-aliases/Updater.md)\<`TData`\>
369β
370#### Returns
371β
372`void`
373β
374***
375β
376### insertValue()
377β
378```ts
379insertValue(
380 index,
381 value,
382 options?): void;
383```
384β
385Defined in: [packages/form-core/src/FieldApi.ts:1123](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1123)
386β
387Inserts a value at the specified index, shifting the subsequent values to the right.
388β
389#### Parameters
390β
391##### index
392β
393`number`
394β
395##### value
396β
397`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
398β
399##### options?
400β
401`UpdateMetaOptions`
402β
403#### Returns
404β
405`void`
406β
407***
408β
409### mount()
410β
411```ts
412mount(): () => void;
413```
414β
415Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859)
416β
417Mounts the field instance to the form.
418β
419#### Returns
420β
421A function to unmount the field instance.
422β
423```ts
424(): void;
425```
426β
427##### Returns
428β
429`void`
430β
431#### Implementation of
432β
433```ts
434FieldLikeAPI.mount
435```
436β
437***
438β
439### moveValue()
440β
441```ts
442moveValue(
443 aIndex,
444 bIndex,
445 options?): void;
446```
447β
448Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198)
449β
450Moves the value at the first specified index to the second specified index.
451β
452#### Parameters
453β
454##### aIndex
455β
456`number`
457β
458##### bIndex
459β
460`number`
461β
462##### options?
463β
464`UpdateMetaOptions`
465β
466#### Returns
467β
468`void`
469β
470***
471β
472### parseValueWithSchema()
473β
474```ts
475parseValueWithSchema(schema):
476 | StandardSchemaV1Issue[]
477 | undefined;
478```
479β
480Defined in: [packages/form-core/src/FieldApi.ts:1782](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1782)
481β
482Parses the field's value with the given schema and returns
483issues (if any). This method does NOT set any internal errors.
484β
485#### Parameters
486β
487##### schema
488β
489[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
490β
491The standard schema to parse this field's value with.
492β
493#### Returns
494β
495 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
496 \| `undefined`
497β
498***
499β
500### parseValueWithSchemaAsync()
501β
502```ts
503parseValueWithSchemaAsync(schema): Promise<
504 | StandardSchemaV1Issue[]
505| undefined>;
506```
507β
508Defined in: [packages/form-core/src/FieldApi.ts:1794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1794)
509β
510Parses the field's value with the given schema and returns
511issues (if any). This method does NOT set any internal errors.
512β
513#### Parameters
514β
515##### schema
516β
517[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
518β
519The standard schema to parse this field's value with.
520β
521#### Returns
522β
523`Promise`\<
524 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
525 \| `undefined`\>
526β
527***
528β
529### pushValue()
530β
531```ts
532pushValue(value, options?): void;
533```
534β
535Defined in: [packages/form-core/src/FieldApi.ts:1105](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1105)
536β
537Pushes a new value to the field.
538β
539#### Parameters
540β
541##### value
542β
543`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
544β
545##### options?
546β
547`UpdateMetaOptions`
548β
549#### Returns
550β
551`void`
552β
553***
554β
555### removeValue()
556β
557```ts
558removeValue(index, options?): void;
559```
560β
561Defined in: [packages/form-core/src/FieldApi.ts:1163](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1163)
562β
563Removes a value at the specified index.
564β
565#### Parameters
566β
567##### index
568β
569`number`
570β
571##### options?
572β
573`UpdateMetaOptions`
574β
575#### Returns
576β
577`void`
578β
579***
580β
581### replaceValue()
582β
583```ts
584replaceValue(
585 index,
586 value,
587 options?): void;
588```
589β
590Defined in: [packages/form-core/src/FieldApi.ts:1143](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1143)
591β
592Replaces a value at the specified index.
593β
594#### Parameters
595β
596##### index
597β
598`number`
599β
600##### value
601β
602`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
603β
604##### options?
605β
606`UpdateMetaOptions`
607β
608#### Returns
609β
610`void`
611β
612***
613β
614### setErrorMap()
615β
616```ts
617setErrorMap(errorMap): void;
618```
619β
620Defined in: [packages/form-core/src/FieldApi.ts:1755](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1755)
621β
622Updates the field's errorMap
623β
624#### Parameters
625β
626##### errorMap
627β
628`ValidationErrorMap`\<[`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnMount`, `TFormOnMount`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnChange`, `TFormOnChange`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnChangeAsync`, `TFormOnChangeAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnBlur`, `TFormOnBlur`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnBlurAsync`, `TFormOnBlurAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnSubmit`, `TFormOnSubmit`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnSubmitAsync`, `TFormOnSubmitAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnDynamic`, `TFormOnDynamic`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnDynamicAsync`, `TFormOnDynamicAsync`\>\>
629β
630#### Returns
631β
632`void`
633β
634***
635β
636### setMeta()
637β
638```ts
639setMeta(updater): void;
640```
641β
642Defined in: [packages/form-core/src/FieldApi.ts:1069](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1069)
643β
644Sets the field metadata.
645β
646#### Parameters
647β
648##### updater
649β
650[`Updater`](../type-aliases/Updater.md)\<`FieldLikeMetaBase`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>\>
651β
652#### Returns
653β
654`void`
655β
656#### Implementation of
657β
658```ts
659FieldLikeAPI.setMeta
660```
661β
662***
663β
664### setValue()
665β
666```ts
667setValue(updater, options?): void;
668```
669β
670Defined in: [packages/form-core/src/FieldApi.ts:1048](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1048)
671β
672Sets the field value and run the `change` validator.
673β
674#### Parameters
675β
676##### updater
677β
678[`Updater`](../type-aliases/Updater.md)\<`TData`\>
679β
680##### options?
681β
682`UpdateMetaOptions`
683β
684#### Returns
685β
686`void`
687β
688#### Implementation of
689β
690```ts
691FieldLikeAPI.setValue
692```
693β
694***
695β
696### swapValues()
697β
698```ts
699swapValues(
700 aIndex,
701 bIndex,
702 options?): void;
703```
704β
705Defined in: [packages/form-core/src/FieldApi.ts:1178](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1178)
706β
707Swaps the values at the specified indices.
708β
709#### Parameters
710β
711##### aIndex
712β
713`number`
714β
715##### bIndex
716β
717`number`
718β
719##### options?
720β
721`UpdateMetaOptions`
722β
723#### Returns
724β
725`void`
726β
727***
728β
729### update()
730β
731```ts
732update(opts): void;
733```
734β
735Defined in: [packages/form-core/src/FieldApi.ts:990](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L990)
736β
737Updates the field instance with new options.
738β
739#### Parameters
740β
741##### opts
742β
743[`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
744β
745#### Returns
746β
747`void`
748β
749***
750β
751### validate()
752β
753```ts
754validate(cause, opts?): unknown[] | Promise<unknown[]>;
755```
756β
757Defined in: [packages/form-core/src/FieldApi.ts:1615](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1615)
758β
759Validates the field value.
760β
761#### Parameters
762β
763##### cause
764β
765`ValidationCause`
766β
767##### opts?
768β
769###### skipFormValidation?
770β
771`boolean`
772β
773###### skipGroupValidation?
774β
775`boolean`
776β
777#### Returns
778β
779`unknown`[] \| `Promise`\<`unknown`[]\>
780β
781#### Implementation of
782β
783```ts
784FieldLikeAPI.validate
785```