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

FieldApi.md

721 lines18.0 KB

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:980](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L980)
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:1134](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1134)
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:1034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1034)
143​
144A reference to the form API instance.
145​
146***
147​
148### name
149​
150```ts
151name: TName;
152```
153​
154Defined in: [packages/form-core/src/FieldApi.ts:1062](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1062)
155​
156The field name.
157​
158***
159​
160### options
161​
162```ts
163options: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
164```
165​
166Defined in: [packages/form-core/src/FieldApi.ts:1066](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1066)
167​
168The field options.
169​
170***
171​
172### store
173​
174```ts
175store: ReadonlyStore<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>;
176```
177​
178Defined in: [packages/form-core/src/FieldApi.ts:1094](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1094)
179​
180The field state store.
181​
182***
183​
184### timeoutIds
185​
186```ts
187timeoutIds: object;
188```
189​
190Defined in: [packages/form-core/src/FieldApi.ts:1125](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1125)
191​
192#### formListeners
193​
194```ts
195formListeners: Record<ListenerCause, ReturnType<typeof setTimeout> | null>;
196```
197​
198#### listeners
199​
200```ts
201listeners: Record<ListenerCause, ReturnType<typeof setTimeout> | null>;
202```
203​
204#### validations
205​
206```ts
207validations: Record<ValidationCause, ReturnType<typeof setTimeout> | null>;
208```
209​
210## Accessors
211​
212### state
213​
214#### Get Signature
215​
216```ts
217get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
218```
219​
220Defined in: [packages/form-core/src/FieldApi.ts:1122](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1122)
221​
222The current field state.
223​
224##### Returns
225​
226[`FieldState`](../type-aliases/FieldState.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>
227​
228## Methods
229​
230### clearValues()
231​
232```ts
233clearValues(options?): void;
234```
235​
236Defined in: [packages/form-core/src/FieldApi.ts:1636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1636)
237​
238Clear all values from the array.
239​
240#### Parameters
241​
242##### options?
243​
244`UpdateMetaOptions`
245​
246#### Returns
247​
248`void`
249​
250***
251​
252### getInfo()
253​
254```ts
255getInfo(): FieldInfo<TParentData>;
256```
257​
258Defined in: [packages/form-core/src/FieldApi.ts:1522](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1522)
259​
260Gets the field information object.
261​
262#### Returns
263​
264[`FieldInfo`](../type-aliases/FieldInfo.md)\<`TParentData`\>
265​
266***
267​
268### getMeta()
269​
270```ts
271getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
272```
273​
274Defined in: [packages/form-core/src/FieldApi.ts:1486](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1486)
275​
276#### Returns
277​
278[`FieldMeta`](../type-aliases/FieldMeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>
279​
280***
281​
282### ~~getValue()~~
283​
284```ts
285getValue(): TData;
286```
287​
288Defined in: [packages/form-core/src/FieldApi.ts:1463](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1463)
289​
290Gets the current field value.
291​
292#### Returns
293​
294`TData`
295​
296#### Deprecated
297​
298Use `field.state.value` instead.
299​
300***
301​
302### handleBlur()
303​
304```ts
305handleBlur(): void;
306```
307​
308Defined in: [packages/form-core/src/FieldApi.ts:2031](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2031)
309​
310Handles the blur event.
311​
312#### Returns
313​
314`void`
315​
316***
317​
318### handleChange()
319​
320```ts
321handleChange(updater): void;
322```
323​
324Defined in: [packages/form-core/src/FieldApi.ts:2024](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2024)
325​
326Handles the change event.
327​
328#### Parameters
329​
330##### updater
331​
332[`Updater`](../type-aliases/Updater.md)\<`TData`\>
333​
334#### Returns
335​
336`void`
337​
338***
339​
340### insertValue()
341​
342```ts
343insertValue(
344 index,
345 value,
346 options?): void;
347```
348​
349Defined in: [packages/form-core/src/FieldApi.ts:1545](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1545)
350​
351Inserts a value at the specified index, shifting the subsequent values to the right.
352​
353#### Parameters
354​
355##### index
356​
357`number`
358​
359##### value
360​
361`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
362​
363##### options?
364​
365`UpdateMetaOptions`
366​
367#### Returns
368​
369`void`
370​
371***
372​
373### mount()
374​
375```ts
376mount(): () => void;
377```
378​
379Defined in: [packages/form-core/src/FieldApi.ts:1281](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1281)
380​
381Mounts the field instance to the form.
382​
383#### Returns
384​
385A function to unmount the field instance.
386​
387```ts
388(): void;
389```
390​
391##### Returns
392​
393`void`
394​
395***
396​
397### moveValue()
398​
399```ts
400moveValue(
401 aIndex,
402 bIndex,
403 options?): void;
404```
405​
406Defined in: [packages/form-core/src/FieldApi.ts:1620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1620)
407​
408Moves the value at the first specified index to the second specified index.
409​
410#### Parameters
411​
412##### aIndex
413​
414`number`
415​
416##### bIndex
417​
418`number`
419​
420##### options?
421​
422`UpdateMetaOptions`
423​
424#### Returns
425​
426`void`
427​
428***
429​
430### parseValueWithSchema()
431​
432```ts
433parseValueWithSchema(schema):
434 | StandardSchemaV1Issue[]
435 | undefined;
436```
437​
438Defined in: [packages/form-core/src/FieldApi.ts:2074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2074)
439​
440Parses the field's value with the given schema and returns
441issues (if any). This method does NOT set any internal errors.
442​
443#### Parameters
444​
445##### schema
446​
447[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
448​
449The standard schema to parse this field's value with.
450​
451#### Returns
452​
453 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
454 \| `undefined`
455​
456***
457​
458### parseValueWithSchemaAsync()
459​
460```ts
461parseValueWithSchemaAsync(schema): Promise<
462 | StandardSchemaV1Issue[]
463| undefined>;
464```
465​
466Defined in: [packages/form-core/src/FieldApi.ts:2086](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2086)
467​
468Parses the field's value with the given schema and returns
469issues (if any). This method does NOT set any internal errors.
470​
471#### Parameters
472​
473##### schema
474​
475[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
476​
477The standard schema to parse this field's value with.
478​
479#### Returns
480​
481`Promise`\<
482 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
483 \| `undefined`\>
484​
485***
486​
487### pushValue()
488​
489```ts
490pushValue(value, options?): void;
491```
492​
493Defined in: [packages/form-core/src/FieldApi.ts:1527](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1527)
494​
495Pushes a new value to the field.
496​
497#### Parameters
498​
499##### value
500​
501`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
502​
503##### options?
504​
505`UpdateMetaOptions`
506​
507#### Returns
508​
509`void`
510​
511***
512​
513### removeValue()
514​
515```ts
516removeValue(index, options?): void;
517```
518​
519Defined in: [packages/form-core/src/FieldApi.ts:1585](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1585)
520​
521Removes a value at the specified index.
522​
523#### Parameters
524​
525##### index
526​
527`number`
528​
529##### options?
530​
531`UpdateMetaOptions`
532​
533#### Returns
534​
535`void`
536​
537***
538​
539### replaceValue()
540​
541```ts
542replaceValue(
543 index,
544 value,
545 options?): void;
546```
547​
548Defined in: [packages/form-core/src/FieldApi.ts:1565](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1565)
549​
550Replaces a value at the specified index.
551​
552#### Parameters
553​
554##### index
555​
556`number`
557​
558##### value
559​
560`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
561​
562##### options?
563​
564`UpdateMetaOptions`
565​
566#### Returns
567​
568`void`
569​
570***
571​
572### setErrorMap()
573​
574```ts
575setErrorMap(errorMap): void;
576```
577​
578Defined in: [packages/form-core/src/FieldApi.ts:2047](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2047)
579​
580Updates the field's errorMap
581​
582#### Parameters
583​
584##### errorMap
585​
586`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`\>\>
587​
588#### Returns
589​
590`void`
591​
592***
593​
594### setMeta()
595​
596```ts
597setMeta(updater): void;
598```
599​
600Defined in: [packages/form-core/src/FieldApi.ts:1491](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1491)
601​
602Sets the field metadata.
603​
604#### Parameters
605​
606##### updater
607​
608[`Updater`](../type-aliases/Updater.md)\<[`FieldMetaBase`](../type-aliases/FieldMetaBase.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>\>
609​
610#### Returns
611​
612`void`
613​
614***
615​
616### setValue()
617​
618```ts
619setValue(updater, options?): void;
620```
621​
622Defined in: [packages/form-core/src/FieldApi.ts:1470](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1470)
623​
624Sets the field value and run the `change` validator.
625​
626#### Parameters
627​
628##### updater
629​
630[`Updater`](../type-aliases/Updater.md)\<`TData`\>
631​
632##### options?
633​
634`UpdateMetaOptions`
635​
636#### Returns
637​
638`void`
639​
640***
641​
642### swapValues()
643​
644```ts
645swapValues(
646 aIndex,
647 bIndex,
648 options?): void;
649```
650​
651Defined in: [packages/form-core/src/FieldApi.ts:1600](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1600)
652​
653Swaps the values at the specified indices.
654​
655#### Parameters
656​
657##### aIndex
658​
659`number`
660​
661##### bIndex
662​
663`number`
664​
665##### options?
666​
667`UpdateMetaOptions`
668​
669#### Returns
670​
671`void`
672​
673***
674​
675### update()
676​
677```ts
678update(opts): void;
679```
680​
681Defined in: [packages/form-core/src/FieldApi.ts:1412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1412)
682​
683Updates the field instance with new options.
684​
685#### Parameters
686​
687##### opts
688​
689[`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`\>
690​
691#### Returns
692​
693`void`
694​
695***
696​
697### validate()
698​
699```ts
700validate(cause, opts?): unknown[] | Promise<unknown[]>;
701```
702​
703Defined in: [packages/form-core/src/FieldApi.ts:1991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1991)
704​
705Validates the field value.
706​
707#### Parameters
708​
709##### cause
710​
711`ValidationCause`
712​
713##### opts?
714​
715###### skipFormValidation?
716​
717`boolean`
718​
719#### Returns
720​
721`unknown`[] \| `Promise`\<`unknown`[]\>