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