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

FieldApi.md

719 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:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979)
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:1133](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1133)
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:1033](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1033)
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:1061](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1061)
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:1065](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1065)
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:1093](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1093)
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:1124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1124)
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:1121](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1121)
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:1556](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1556)
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:1442](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1442)
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:1406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1406)
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:1383](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1383)
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:1944](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1944)
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:1937](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1937)
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:1465](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1465)
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:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279)
380​
381Mounts the field instance to the form.
382​
383#### Returns
384​
385```ts
386(): void;
387```
388​
389##### Returns
390​
391`void`
392​
393***
394​
395### moveValue()
396​
397```ts
398moveValue(
399 aIndex,
400 bIndex,
401 options?): void;
402```
403​
404Defined in: [packages/form-core/src/FieldApi.ts:1540](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1540)
405​
406Moves the value at the first specified index to the second specified index.
407​
408#### Parameters
409​
410##### aIndex
411​
412`number`
413​
414##### bIndex
415​
416`number`
417​
418##### options?
419​
420`UpdateMetaOptions`
421​
422#### Returns
423​
424`void`
425​
426***
427​
428### parseValueWithSchema()
429​
430```ts
431parseValueWithSchema(schema):
432 | StandardSchemaV1Issue[]
433 | undefined;
434```
435​
436Defined in: [packages/form-core/src/FieldApi.ts:1987](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1987)
437​
438Parses the field's value with the given schema and returns
439issues (if any). This method does NOT set any internal errors.
440​
441#### Parameters
442​
443##### schema
444​
445[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
446​
447The standard schema to parse this field's value with.
448​
449#### Returns
450​
451 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
452 \| `undefined`
453​
454***
455​
456### parseValueWithSchemaAsync()
457​
458```ts
459parseValueWithSchemaAsync(schema): Promise<
460 | StandardSchemaV1Issue[]
461| undefined>;
462```
463​
464Defined in: [packages/form-core/src/FieldApi.ts:1999](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1999)
465​
466Parses the field's value with the given schema and returns
467issues (if any). This method does NOT set any internal errors.
468​
469#### Parameters
470​
471##### schema
472​
473[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\>
474​
475The standard schema to parse this field's value with.
476​
477#### Returns
478​
479`Promise`\<
480 \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]
481 \| `undefined`\>
482​
483***
484​
485### pushValue()
486​
487```ts
488pushValue(value, options?): void;
489```
490​
491Defined in: [packages/form-core/src/FieldApi.ts:1447](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1447)
492​
493Pushes a new value to the field.
494​
495#### Parameters
496​
497##### value
498​
499`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
500​
501##### options?
502​
503`UpdateMetaOptions`
504​
505#### Returns
506​
507`void`
508​
509***
510​
511### removeValue()
512​
513```ts
514removeValue(index, options?): void;
515```
516​
517Defined in: [packages/form-core/src/FieldApi.ts:1505](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1505)
518​
519Removes a value at the specified index.
520​
521#### Parameters
522​
523##### index
524​
525`number`
526​
527##### options?
528​
529`UpdateMetaOptions`
530​
531#### Returns
532​
533`void`
534​
535***
536​
537### replaceValue()
538​
539```ts
540replaceValue(
541 index,
542 value,
543 options?): void;
544```
545​
546Defined in: [packages/form-core/src/FieldApi.ts:1485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1485)
547​
548Replaces a value at the specified index.
549​
550#### Parameters
551​
552##### index
553​
554`number`
555​
556##### value
557​
558`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
559​
560##### options?
561​
562`UpdateMetaOptions`
563​
564#### Returns
565​
566`void`
567​
568***
569​
570### setErrorMap()
571​
572```ts
573setErrorMap(errorMap): void;
574```
575​
576Defined in: [packages/form-core/src/FieldApi.ts:1960](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1960)
577​
578Updates the field's errorMap
579​
580#### Parameters
581​
582##### errorMap
583​
584`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`\>\>
585​
586#### Returns
587​
588`void`
589​
590***
591​
592### setMeta()
593​
594```ts
595setMeta(updater): void;
596```
597​
598Defined in: [packages/form-core/src/FieldApi.ts:1411](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1411)
599​
600Sets the field metadata.
601​
602#### Parameters
603​
604##### updater
605​
606[`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`\>\>
607​
608#### Returns
609​
610`void`
611​
612***
613​
614### setValue()
615​
616```ts
617setValue(updater, options?): void;
618```
619​
620Defined in: [packages/form-core/src/FieldApi.ts:1390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1390)
621​
622Sets the field value and run the `change` validator.
623​
624#### Parameters
625​
626##### updater
627​
628[`Updater`](../type-aliases/Updater.md)\<`TData`\>
629​
630##### options?
631​
632`UpdateMetaOptions`
633​
634#### Returns
635​
636`void`
637​
638***
639​
640### swapValues()
641​
642```ts
643swapValues(
644 aIndex,
645 bIndex,
646 options?): void;
647```
648​
649Defined in: [packages/form-core/src/FieldApi.ts:1520](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1520)
650​
651Swaps the values at the specified indices.
652​
653#### Parameters
654​
655##### aIndex
656​
657`number`
658​
659##### bIndex
660​
661`number`
662​
663##### options?
664​
665`UpdateMetaOptions`
666​
667#### Returns
668​
669`void`
670​
671***
672​
673### update()
674​
675```ts
676update(opts): void;
677```
678​
679Defined in: [packages/form-core/src/FieldApi.ts:1332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1332)
680​
681Updates the field instance with new options.
682​
683#### Parameters
684​
685##### opts
686​
687[`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`\>
688​
689#### Returns
690​
691`void`
692​
693***
694​
695### validate()
696​
697```ts
698validate(cause, opts?): unknown[] | Promise<unknown[]>;
699```
700​
701Defined in: [packages/form-core/src/FieldApi.ts:1904](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1904)
702​
703Validates the field value.
704​
705#### Parameters
706​
707##### cause
708​
709`ValidationCause`
710​
711##### opts?
712​
713###### skipFormValidation?
714​
715`boolean`
716​
717#### Returns
718​
719`unknown`[] \| `Promise`\<`unknown`[]\>