Open History to see the last commit
1---
2id: FormApi
3title: FormApi
4---
5β
6# Class: FormApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
7β
8Defined in: [packages/form-core/src/FormApi.ts:866](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L866)
9β
10A class representing the Form API. It handles the logic and interactions with the form state.
11β
12Normally, you will not need to create a new `FormApi` instance directly. Instead, you will use a framework
13hook/function like `useForm` or `createForm` to create a new instance for you that uses your framework's reactivity model.
14However, if you need to create a new instance manually, you can do so by calling the `new FormApi` constructor.
15β
16## Type Parameters
17β
18### TFormData
19β
20`TFormData`
21β
22### TOnMount
23β
24`TOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
25β
26### TOnChange
27β
28`TOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
29β
30### TOnChangeAsync
31β
32`TOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
33β
34### TOnBlur
35β
36`TOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
37β
38### TOnBlurAsync
39β
40`TOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
41β
42### TOnSubmit
43β
44`TOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
45β
46### TOnSubmitAsync
47β
48`TOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
49β
50### TOnDynamic
51β
52`TOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
53β
54### TOnDynamicAsync
55β
56`TOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
57β
58### TOnServer
59β
60`TOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
61β
62### TSubmitMeta
63β
64`TSubmitMeta` = `never`
65β
66## Constructors
67β
68### Constructor
69β
70```ts
71new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
72```
73β
74Defined in: [packages/form-core/src/FormApi.ts:972](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L972)
75β
76Constructs a new `FormApi` instance with the given form options.
77β
78#### Parameters
79β
80##### opts?
81β
82[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
83β
84#### Returns
85β
86`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
87β
88## Properties
89β
90### baseStore
91β
92```ts
93baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
94```
95β
96Defined in: [packages/form-core/src/FormApi.ts:898](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L898)
97β
98***
99β
100### fieldInfo
101β
102```ts
103fieldInfo: Partial<Record<DeepKeys<TFormData>, FieldInfo<TFormData>>> = {};
104```
105β
106Defined in: [packages/form-core/src/FormApi.ts:946](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L946)
107β
108A record of field information for each field in the form.
109β
110***
111β
112### fieldMetaDerived
113β
114```ts
115fieldMetaDerived: Store<Partial<Record<DeepKeys<TFormData>, AnyFieldMeta>>>;
116```
117β
118Defined in: [packages/form-core/src/FormApi.ts:913](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L913)
119β
120***
121β
122### options
123β
124```ts
125options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};
126```
127β
128Defined in: [packages/form-core/src/FormApi.ts:883](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L883)
129β
130The options for the form.
131β
132***
133β
134### store
135β
136```ts
137store: ReadonlyStore<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
138```
139β
140Defined in: [packages/form-core/src/FormApi.ts:928](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L928)
141β
142## Accessors
143β
144### formId
145β
146#### Get Signature
147β
148```ts
149get formId(): string;
150```
151β
152Defined in: [packages/form-core/src/FormApi.ts:1353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1353)
153β
154##### Returns
155β
156`string`
157β
158***
159β
160### state
161β
162#### Get Signature
163β
164```ts
165get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>;
166```
167β
168Defined in: [packages/form-core/src/FormApi.ts:948](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L948)
169β
170##### Returns
171β
172[`FormState`](../interfaces/FormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\>
173β
174## Methods
175β
176### \_handleSubmit()
177β
178```ts
179_handleSubmit(submitMeta?): Promise<void>;
180```
181β
182Defined in: [packages/form-core/src/FormApi.ts:2077](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2077)
183β
184Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
185β
186#### Parameters
187β
188##### submitMeta?
189β
190`TSubmitMeta`
191β
192#### Returns
193β
194`Promise`\<`void`\>
195β
196***
197β
198### clearFieldValues()
199β
200```ts
201clearFieldValues<TField>(field, options?): void;
202```
203β
204Defined in: [packages/form-core/src/FormApi.ts:2543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2543)
205β
206Clear all values within an array field.
207β
208#### Type Parameters
209β
210##### TField
211β
212`TField` *extends* `string`
213β
214#### Parameters
215β
216##### field
217β
218`TField`
219β
220##### options?
221β
222`UpdateMetaOptions`
223β
224#### Returns
225β
226`void`
227β
228#### Implementation of
229β
230```ts
231FieldManipulator.clearFieldValues
232```
233β
234***
235β
236### deleteField()
237β
238```ts
239deleteField<TField>(field): void;
240```
241β
242Defined in: [packages/form-core/src/FormApi.ts:2335](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2335)
243β
244#### Type Parameters
245β
246##### TField
247β
248`TField` *extends* `string`
249β
250#### Parameters
251β
252##### field
253β
254`TField`
255β
256#### Returns
257β
258`void`
259β
260#### Implementation of
261β
262```ts
263FieldManipulator.deleteField
264```
265β
266***
267β
268### getAllErrors()
269β
270```ts
271getAllErrors(): object;
272```
273β
274Defined in: [packages/form-core/src/FormApi.ts:2658](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2658)
275β
276Returns form and field level errors
277β
278#### Returns
279β
280`object`
281β
282##### fields
283β
284```ts
285fields: Record<DeepKeys<TFormData>, {
286 errorMap: ValidationErrorMap;
287 errors: ValidationError[];
288}>;
289```
290β
291##### form
292β
293```ts
294form: object;
295```
296β
297###### form.errorMap
298β
299```ts
300errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
301```
302β
303###### form.errors
304β
305```ts
306errors: (
307 | UnwrapFormValidateOrFn<TOnMount>
308 | UnwrapFormValidateOrFn<TOnChange>
309 | UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
310 | UnwrapFormValidateOrFn<TOnBlur>
311 | UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
312 | UnwrapFormValidateOrFn<TOnSubmit>
313 | UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
314 | UnwrapFormValidateOrFn<TOnDynamic>
315 | UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
316 | UnwrapFormAsyncValidateOrFn<TOnServer>)[];
317```
318β
319***
320β
321### getFieldInfo()
322β
323```ts
324getFieldInfo<TField>(field): FieldInfo<TFormData>;
325```
326β
327Defined in: [packages/form-core/src/FormApi.ts:2239](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2239)
328β
329Gets the field info of the specified field.
330β
331#### Type Parameters
332β
333##### TField
334β
335`TField` *extends* `string`
336β
337#### Parameters
338β
339##### field
340β
341`TField`
342β
343#### Returns
344β
345[`FieldInfo`](../type-aliases/FieldInfo.md)\<`TFormData`\>
346β
347***
348β
349### getFieldMeta()
350β
351```ts
352getFieldMeta<TField>(field): AnyFieldMeta | undefined;
353```
354β
355Defined in: [packages/form-core/src/FormApi.ts:2230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2230)
356β
357Gets the metadata of the specified field.
358β
359#### Type Parameters
360β
361##### TField
362β
363`TField` *extends* `string`
364β
365#### Parameters
366β
367##### field
368β
369`TField`
370β
371#### Returns
372β
373[`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md) \| `undefined`
374β
375#### Implementation of
376β
377```ts
378FieldManipulator.getFieldMeta
379```
380β
381***
382β
383### getFieldValue()
384β
385```ts
386getFieldValue<TField>(field): DeepValue<TFormData, TField>;
387```
388β
389Defined in: [packages/form-core/src/FormApi.ts:2223](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2223)
390β
391Gets the value of the specified field.
392β
393#### Type Parameters
394β
395##### TField
396β
397`TField` *extends* `string`
398β
399#### Parameters
400β
401##### field
402β
403`TField`
404β
405#### Returns
406β
407[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>
408β
409#### Implementation of
410β
411```ts
412FieldManipulator.getFieldValue
413```
414β
415***
416β
417### handleSubmit()
418β
419#### Call Signature
420β
421```ts
422handleSubmit(): Promise<void>;
423```
424β
425Defined in: [packages/form-core/src/FormApi.ts:2068](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2068)
426β
427Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
428β
429##### Returns
430β
431`Promise`\<`void`\>
432β
433##### Implementation of
434β
435```ts
436FieldManipulator.handleSubmit
437```
438β
439#### Call Signature
440β
441```ts
442handleSubmit(submitMeta): Promise<void>;
443```
444β
445Defined in: [packages/form-core/src/FormApi.ts:2069](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2069)
446β
447##### Parameters
448β
449###### submitMeta
450β
451`TSubmitMeta`
452β
453##### Returns
454β
455`Promise`\<`void`\>
456β
457##### Implementation of
458β
459```ts
460FieldManipulator.handleSubmit
461```
462β
463***
464β
465### insertFieldValue()
466β
467```ts
468insertFieldValue<TField>(
469 field,
470 index,
471 value,
472options?): Promise<void>;
473```
474β
475Defined in: [packages/form-core/src/FormApi.ts:2373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2373)
476β
477#### Type Parameters
478β
479##### TField
480β
481`TField` *extends* `string`
482β
483#### Parameters
484β
485##### field
486β
487`TField`
488β
489##### index
490β
491`number`
492β
493##### value
494β
495[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
496β
497##### options?
498β
499`UpdateMetaOptions`
500β
501#### Returns
502β
503`Promise`\<`void`\>
504β
505#### Implementation of
506β
507```ts
508FieldManipulator.insertFieldValue
509```
510β
511***
512β
513### mount()
514β
515```ts
516mount(): () => void;
517```
518β
519Defined in: [packages/form-core/src/FormApi.ts:1382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1382)
520β
521#### Returns
522β
523```ts
524(): void;
525```
526β
527##### Returns
528β
529`void`
530β
531***
532β
533### moveFieldValues()
534β
535```ts
536moveFieldValues<TField>(
537 field,
538 index1,
539 index2,
540 options?): void;
541```
542β
543Defined in: [packages/form-core/src/FormApi.ts:2511](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2511)
544β
545Moves the value at the first specified index to the second specified index within an array field.
546β
547#### Type Parameters
548β
549##### TField
550β
551`TField` *extends* `string`
552β
553#### Parameters
554β
555##### field
556β
557`TField`
558β
559##### index1
560β
561`number`
562β
563##### index2
564β
565`number`
566β
567##### options?
568β
569`UpdateMetaOptions`
570β
571#### Returns
572β
573`void`
574β
575#### Implementation of
576β
577```ts
578FieldManipulator.moveFieldValues
579```
580β
581***
582β
583### parseValuesWithSchema()
584β
585```ts
586parseValuesWithSchema(schema):
587 | {
588 fields: Record<string, StandardSchemaV1Issue[]>;
589 form: Record<string, StandardSchemaV1Issue[]>;
590}
591 | undefined;
592```
593β
594Defined in: [packages/form-core/src/FormApi.ts:2722](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2722)
595β
596Parses the form's values with a given standard schema and returns
597issues (if any). This method does NOT set any internal errors.
598β
599#### Parameters
600β
601##### schema
602β
603[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\>
604β
605The standard schema to parse the form values with.
606β
607#### Returns
608β
609 \| \{
610 `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>;
611 `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>;
612\}
613 \| `undefined`
614β
615***
616β
617### parseValuesWithSchemaAsync()
618β
619```ts
620parseValuesWithSchemaAsync(schema): Promise<
621 | {
622 fields: Record<string, StandardSchemaV1Issue[]>;
623 form: Record<string, StandardSchemaV1Issue[]>;
624}
625| undefined>;
626```
627β
628Defined in: [packages/form-core/src/FormApi.ts:2734](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2734)
629β
630Parses the form's values with a given standard schema and returns
631issues (if any). This method does NOT set any internal errors.
632β
633#### Parameters
634β
635##### schema
636β
637[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\>
638β
639The standard schema to parse the form values with.
640β
641#### Returns
642β
643`Promise`\<
644 \| \{
645 `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>;
646 `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>;
647\}
648 \| `undefined`\>
649β
650***
651β
652### pushFieldValue()
653β
654```ts
655pushFieldValue<TField>(
656 field,
657 value,
658 options?): void;
659```
660β
661Defined in: [packages/form-core/src/FormApi.ts:2359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2359)
662β
663Pushes a value into an array field.
664β
665#### Type Parameters
666β
667##### TField
668β
669`TField` *extends* `string`
670β
671#### Parameters
672β
673##### field
674β
675`TField`
676β
677##### value
678β
679[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
680β
681##### options?
682β
683`UpdateMetaOptions`
684β
685#### Returns
686β
687`void`
688β
689#### Implementation of
690β
691```ts
692FieldManipulator.pushFieldValue
693```
694β
695***
696β
697### removeFieldValue()
698β
699```ts
700removeFieldValue<TField>(
701 field,
702 index,
703options?): Promise<void>;
704```
705β
706Defined in: [packages/form-core/src/FormApi.ts:2439](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2439)
707β
708Removes a value from an array field at the specified index.
709β
710#### Type Parameters
711β
712##### TField
713β
714`TField` *extends* `string`
715β
716#### Parameters
717β
718##### field
719β
720`TField`
721β
722##### index
723β
724`number`
725β
726##### options?
727β
728`UpdateMetaOptions`
729β
730#### Returns
731β
732`Promise`\<`void`\>
733β
734#### Implementation of
735β
736```ts
737FieldManipulator.removeFieldValue
738```
739β
740***
741β
742### replaceFieldValue()
743β
744```ts
745replaceFieldValue<TField>(
746 field,
747 index,
748 value,
749options?): Promise<void>;
750```
751β
752Defined in: [packages/form-core/src/FormApi.ts:2410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2410)
753β
754Replaces a value into an array field at the specified index.
755β
756#### Type Parameters
757β
758##### TField
759β
760`TField` *extends* `string`
761β
762#### Parameters
763β
764##### field
765β
766`TField`
767β
768##### index
769β
770`number`
771β
772##### value
773β
774[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
775β
776##### options?
777β
778`UpdateMetaOptions`
779β
780#### Returns
781β
782`Promise`\<`void`\>
783β
784#### Implementation of
785β
786```ts
787FieldManipulator.replaceFieldValue
788```
789β
790***
791β
792### reset()
793β
794```ts
795reset(values?, opts?): void;
796```
797β
798Defined in: [packages/form-core/src/FormApi.ts:1523](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1523)
799β
800Resets the form state to the default values.
801If values are provided, the form will be reset to those values instead and the default values will be updated.
802β
803#### Parameters
804β
805##### values?
806β
807`TFormData`
808β
809Optional values to reset the form to.
810β
811##### opts?
812β
813Optional options to control the reset behavior.
814β
815###### keepDefaultValues?
816β
817`boolean`
818β
819#### Returns
820β
821`void`
822β
823***
824β
825### resetField()
826β
827```ts
828resetField<TField>(field): void;
829```
830β
831Defined in: [packages/form-core/src/FormApi.ts:2576](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2576)
832β
833Resets the field value and meta to default state
834β
835#### Type Parameters
836β
837##### TField
838β
839`TField` *extends* `string`
840β
841#### Parameters
842β
843##### field
844β
845`TField`
846β
847#### Returns
848β
849`void`
850β
851#### Implementation of
852β
853```ts
854FieldManipulator.resetField
855```
856β
857***
858β
859### resetFieldMeta()
860β
861```ts
862resetFieldMeta<TField>(fieldMeta): Partial<Record<TField, AnyFieldMeta>>;
863```
864β
865Defined in: [packages/form-core/src/FormApi.ts:2279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2279)
866β
867resets every field's meta
868β
869#### Type Parameters
870β
871##### TField
872β
873`TField` *extends* `string`
874β
875#### Parameters
876β
877##### fieldMeta
878β
879`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md)\>\>
880β
881#### Returns
882β
883`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md)\>\>
884β
885***
886β
887### setErrorMap()
888β
889```ts
890setErrorMap(errorMap): void;
891```
892β
893Defined in: [packages/form-core/src/FormApi.ts:2594](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2594)
894β
895Updates the form's errorMap
896β
897#### Parameters
898β
899##### errorMap
900β
901`FormValidationErrorMap`\<`TFormData`, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnMount`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnChange`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnChangeAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnBlur`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnBlurAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnSubmit`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnSubmitAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnDynamic`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnDynamicAsync`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnServer`\>\>
902β
903#### Returns
904β
905`void`
906β
907***
908β
909### setFieldMeta()
910β
911```ts
912setFieldMeta<TField>(field, updater): void;
913```
914β
915Defined in: [packages/form-core/src/FormApi.ts:2258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2258)
916β
917Updates the metadata of the specified field.
918β
919#### Type Parameters
920β
921##### TField
922β
923`TField` *extends* `string`
924β
925#### Parameters
926β
927##### field
928β
929`TField`
930β
931##### updater
932β
933[`Updater`](../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../type-aliases/AnyFieldMetaBase.md)\>
934β
935#### Returns
936β
937`void`
938β
939#### Implementation of
940β
941```ts
942FieldManipulator.setFieldMeta
943```
944β
945***
946β
947### setFieldValue()
948β
949```ts
950setFieldValue<TField>(
951 field,
952 updater,
953 opts?): void;
954```
955β
956Defined in: [packages/form-core/src/FormApi.ts:2295](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2295)
957β
958Sets the value of the specified field and optionally updates the touched state.
959β
960#### Type Parameters
961β
962##### TField
963β
964`TField` *extends* `string`
965β
966#### Parameters
967β
968##### field
969β
970`TField`
971β
972##### updater
973β
974[`Updater`](../type-aliases/Updater.md)\<[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\>
975β
976##### opts?
977β
978`UpdateMetaOptions`
979β
980#### Returns
981β
982`void`
983β
984#### Implementation of
985β
986```ts
987FieldManipulator.setFieldValue
988```
989β
990***
991β
992### swapFieldValues()
993β
994```ts
995swapFieldValues<TField>(
996 field,
997 index1,
998 index2,
999 options?): void;
1000```
1001β
1002Defined in: [packages/form-core/src/FormApi.ts:2479](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2479)
1003β
1004Swaps the values at the specified indices within an array field.
1005β
1006#### Type Parameters
1007β
1008##### TField
1009β
1010`TField` *extends* `string`
1011β
1012#### Parameters
1013β
1014##### field
1015β
1016`TField`
1017β
1018##### index1
1019β
1020`number`
1021β
1022##### index2
1023β
1024`number`
1025β
1026##### options?
1027β
1028`UpdateMetaOptions`
1029β
1030#### Returns
1031β
1032`void`
1033β
1034#### Implementation of
1035β
1036```ts
1037FieldManipulator.swapFieldValues
1038```
1039β
1040***
1041β
1042### update()
1043β
1044```ts
1045update(options?): void;
1046```
1047β
1048Defined in: [packages/form-core/src/FormApi.ts:1456](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1456)
1049β
1050Updates the form options and form state.
1051β
1052#### Parameters
1053β
1054##### options?
1055β
1056[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
1057β
1058#### Returns
1059β
1060`void`
1061β
1062***
1063β
1064### validateAllFields()
1065β
1066```ts
1067validateAllFields(cause): Promise<unknown[]>;
1068```
1069β
1070Defined in: [packages/form-core/src/FormApi.ts:1549](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1549)
1071β
1072Validates all fields using the correct handlers for a given validation cause.
1073β
1074#### Parameters
1075β
1076##### cause
1077β
1078`ValidationCause`
1079β
1080#### Returns
1081β
1082`Promise`\<`unknown`[]\>
1083β
1084#### Implementation of
1085β
1086```ts
1087FieldManipulator.validateAllFields
1088```
1089β
1090***
1091β
1092### validateArrayFieldsStartingFrom()
1093β
1094```ts
1095validateArrayFieldsStartingFrom<TField>(
1096 field,
1097 index,
1098cause): Promise<unknown[]>;
1099```
1100β
1101Defined in: [packages/form-core/src/FormApi.ts:1579](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1579)
1102β
1103Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
1104β
1105#### Type Parameters
1106β
1107##### TField
1108β
1109`TField` *extends* `string`
1110β
1111#### Parameters
1112β
1113##### field
1114β
1115`TField`
1116β
1117##### index
1118β
1119`number`
1120β
1121##### cause
1122β
1123`ValidationCause`
1124β
1125#### Returns
1126β
1127`Promise`\<`unknown`[]\>
1128β
1129#### Implementation of
1130β
1131```ts
1132FieldManipulator.validateArrayFieldsStartingFrom
1133```
1134β
1135***
1136β
1137### validateField()
1138β
1139```ts
1140validateField<TField>(field, cause): any[] | Promise<any[]>;
1141```
1142β
1143Defined in: [packages/form-core/src/FormApi.ts:1620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1620)
1144β
1145Validates a specified field in the form using the correct handlers for a given validation type.
1146β
1147#### Type Parameters
1148β
1149##### TField
1150β
1151`TField` *extends* `string`
1152β
1153#### Parameters
1154β
1155##### field
1156β
1157`TField`
1158β
1159##### cause
1160β
1161`ValidationCause`
1162β
1163#### Returns
1164β
1165`any`[] \| `Promise`\<`any`[]\>
1166β
1167#### Implementation of
1168β
1169```ts
1170FieldManipulator.validateField
1171```