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: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`[]\>