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

FormApi.md

1,171 lines22.2 KB

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[]>;
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[]>;
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```