@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/
137
137
deleteField <TField >(field ): void
138
138
` ` `
139
139
140
- Defined in: [packages/form-core/src/FormApi.ts:1938 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938 )
140
+ Defined in: [packages/form-core/src/FormApi.ts:1940 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940 )
141
141
142
142
#### Type Parameters
143
143
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack
161
161
getAllErrors (): object
162
162
` ` `
163
163
164
- Defined in: [packages/form-core/src/FormApi.ts:2212 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2212 )
164
+ Defined in: [packages/form-core/src/FormApi.ts:2214 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2214 )
165
165
166
166
Returns form and field level errors
167
167
@@ -212,7 +212,7 @@ errors: (
212
212
getFieldInfo <TField >(field ): FieldInfo < TFormData >
213
213
` ` `
214
214
215
- Defined in: [packages/form-core/src/FormApi.ts:1852 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852 )
215
+ Defined in: [packages/form-core/src/FormApi.ts:1854 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1854 )
216
216
217
217
Gets the field info of the specified field.
218
218
@@ -238,7 +238,7 @@ Gets the field info of the specified field.
238
238
getFieldMeta <TField >(field ): undefined | AnyFieldMeta
239
239
` ` `
240
240
241
- Defined in: [packages/form-core/src/FormApi.ts:1843 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843 )
241
+ Defined in: [packages/form-core/src/FormApi.ts:1845 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845 )
242
242
243
243
Gets the metadata of the specified field.
244
244
@@ -264,7 +264,7 @@ Gets the metadata of the specified field.
264
264
getFieldValue <TField >(field ): DeepValue < TFormData , TField >
265
265
` ` `
266
266
267
- Defined in: [packages/form-core/src/FormApi.ts:1836 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836 )
267
+ Defined in: [packages/form-core/src/FormApi.ts:1838 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1838 )
268
268
269
269
Gets the value of the specified field.
270
270
@@ -292,7 +292,7 @@ Gets the value of the specified field.
292
292
handleSubmit (): Promise < void >
293
293
` ` `
294
294
295
- Defined in: [packages/form-core/src/FormApi.ts:1738 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738 )
295
+ Defined in: [packages/form-core/src/FormApi.ts:1740 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1740 )
296
296
297
297
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
298
298
@@ -306,7 +306,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu
306
306
handleSubmit (submitMeta ): Promise < void >
307
307
` ` `
308
308
309
- Defined in: [packages/form-core/src/FormApi.ts:1739 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739 )
309
+ Defined in: [packages/form-core/src/FormApi.ts:1741 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1741 )
310
310
311
311
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
312
312
@@ -332,7 +332,7 @@ insertFieldValue<TField>(
332
332
opts ? ): Promise < void >
333
333
` ` `
334
334
335
- Defined in: [packages/form-core/src/FormApi.ts:1977 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977 )
335
+ Defined in: [packages/form-core/src/FormApi.ts:1979 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1979 )
336
336
337
337
#### Type Parameters
338
338
@@ -390,7 +390,7 @@ moveFieldValues<TField>(
390
390
opts ? ): void
391
391
` ` `
392
392
393
- Defined in: [packages/form-core/src/FormApi.ts:2101 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101 )
393
+ Defined in: [packages/form-core/src/FormApi.ts:2103 ](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103 )
394
394
395
395
Moves the value at the first specified index to the second specified index within an array field.
396
396
@@ -433,7 +433,7 @@ parseValuesWithSchema(schema):
433
433
}
434
434
```
435
435
436
- Defined in: [packages / form - core / src / FormApi .ts :2272 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2272 )
436
+ Defined in: [packages / form - core / src / FormApi .ts :2274 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2274 )
437
437
438
438
Parses the form ' s values with a given standard schema and returns
439
439
issues (if any ). This method does NOT set any internal errors .
@@ -467,7 +467,7 @@ parseValuesWithSchemaAsync(schema): Promise<
467
467
}>
468
468
` ` `
469
469
470
- Defined in : [packages / form - core / src / FormApi .ts :2284 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2284 )
470
+ Defined in : [packages / form - core / src / FormApi .ts :2286 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2286 )
471
471
472
472
Parses the form ' s values with a given standard schema and returns
473
473
issues (if any ). This method does NOT set any internal errors .
@@ -500,7 +500,7 @@ pushFieldValue<TField>(
500
500
opts?): void
501
501
` ` `
502
502
503
- Defined in : [packages / form - core / src / FormApi .ts :1962 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962 )
503
+ Defined in : [packages / form - core / src / FormApi .ts :1964 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1964 )
504
504
505
505
Pushes a value into an array field .
506
506
@@ -537,7 +537,7 @@ removeFieldValue<TField>(
537
537
opts?): Promise<void>
538
538
` ` `
539
539
540
- Defined in : [packages / form - core / src / FormApi .ts :2035 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035 )
540
+ Defined in : [packages / form - core / src / FormApi .ts :2037 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2037 )
541
541
542
542
Removes a value from an array field at the specified index .
543
543
@@ -575,7 +575,7 @@ replaceFieldValue<TField>(
575
575
opts?): Promise<void>
576
576
` ` `
577
577
578
- Defined in : [packages / form - core / src / FormApi .ts :2009 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009 )
578
+ Defined in : [packages / form - core / src / FormApi .ts :2011 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2011 )
579
579
580
580
Replaces a value into an array field at the specified index .
581
581
@@ -646,7 +646,7 @@ Optional options to control the reset behavior.
646
646
resetField<TField>(field): void
647
647
` ` `
648
648
649
- Defined in : [packages / form - core / src / FormApi .ts :2129 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129 )
649
+ Defined in : [packages / form - core / src / FormApi .ts :2131 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2131 )
650
650
651
651
Resets the field value and meta to default state
652
652
@@ -672,7 +672,7 @@ Resets the field value and meta to default state
672
672
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
673
673
` ` `
674
674
675
- Defined in : [packages / form - core / src / FormApi .ts :1892 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892 )
675
+ Defined in : [packages / form - core / src / FormApi .ts :1894 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1894 )
676
676
677
677
resets every field ' s meta
678
678
@@ -698,7 +698,7 @@ resets every field's meta
698
698
setErrorMap(errorMap): void
699
699
` ` `
700
700
701
- Defined in : [packages / form - core / src / FormApi .ts :2150 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150 )
701
+ Defined in : [packages / form - core / src / FormApi .ts :2152 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2152 )
702
702
703
703
Updates the form ' s errorMap
704
704
@@ -720,7 +720,7 @@ Updates the form's errorMap
720
720
setFieldMeta<TField>(field, updater): void
721
721
` ` `
722
722
723
- Defined in : [packages / form - core / src / FormApi .ts :1871 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871 )
723
+ Defined in : [packages / form - core / src / FormApi .ts :1873 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1873 )
724
724
725
725
Updates the metadata of the specified field .
726
726
@@ -753,7 +753,7 @@ setFieldValue<TField>(
753
753
opts?): void
754
754
` ` `
755
755
756
- Defined in : [packages / form - core / src / FormApi .ts :1908 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908 )
756
+ Defined in : [packages / form - core / src / FormApi .ts :1910 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1910 )
757
757
758
758
Sets the value of the specified field and optionally updates the touched state .
759
759
@@ -791,7 +791,7 @@ swapFieldValues<TField>(
791
791
opts?): void
792
792
` ` `
793
793
794
- Defined in : [packages / form - core / src / FormApi .ts :2072 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072 )
794
+ Defined in : [packages / form - core / src / FormApi .ts :2074 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2074 )
795
795
796
796
Swaps the values at the specified indices within an array field .
797
797
@@ -910,7 +910,7 @@ Validates the children of a specified array in the form starting from a given in
910
910
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
911
911
` ` `
912
912
913
- Defined in : [packages / form - core / src / FormApi .ts :1351 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351 )
913
+ Defined in : [packages / form - core / src / FormApi .ts :1353 ](https :// github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1353 )
914
914
915
915
Validates a specified field in the form using the correct handlers for a given validation type .
916
916
0 commit comments