Skip to content

Commit c61349e

Browse files
ci: apply automated fixes and generate docs
1 parent e54355c commit c61349e

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/reference/classes/FormApi.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Defined in: [packages/form-core/src/FormApi.ts:969](https://github.com/TanStack/
179179
_handleSubmit(submitMeta?): Promise<void>;
180180
```
181181
182-
Defined in: [packages/form-core/src/FormApi.ts:2038](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2038)
182+
Defined in: [packages/form-core/src/FormApi.ts:2043](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2043)
183183
184184
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
185185
@@ -201,7 +201,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu
201201
clearFieldValues<TField>(field, options?): void;
202202
```
203203
204-
Defined in: [packages/form-core/src/FormApi.ts:2505](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2505)
204+
Defined in: [packages/form-core/src/FormApi.ts:2510](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2510)
205205
206206
Clear all values within an array field.
207207
@@ -239,7 +239,7 @@ FieldManipulator.clearFieldValues
239239
deleteField<TField>(field): void;
240240
```
241241
242-
Defined in: [packages/form-core/src/FormApi.ts:2297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2297)
242+
Defined in: [packages/form-core/src/FormApi.ts:2302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2302)
243243
244244
#### Type Parameters
245245
@@ -271,7 +271,7 @@ FieldManipulator.deleteField
271271
getAllErrors(): object;
272272
```
273273
274-
Defined in: [packages/form-core/src/FormApi.ts:2620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2620)
274+
Defined in: [packages/form-core/src/FormApi.ts:2625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2625)
275275
276276
Returns form and field level errors
277277
@@ -324,7 +324,7 @@ errors: (
324324
getFieldInfo<TField>(field): FieldInfo<TFormData>;
325325
```
326326
327-
Defined in: [packages/form-core/src/FormApi.ts:2200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2200)
327+
Defined in: [packages/form-core/src/FormApi.ts:2205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2205)
328328
329329
Gets the field info of the specified field.
330330
@@ -352,7 +352,7 @@ Gets the field info of the specified field.
352352
getFieldMeta<TField>(field): AnyFieldMeta | undefined;
353353
```
354354
355-
Defined in: [packages/form-core/src/FormApi.ts:2191](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2191)
355+
Defined in: [packages/form-core/src/FormApi.ts:2196](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2196)
356356
357357
Gets the metadata of the specified field.
358358
@@ -386,7 +386,7 @@ FieldManipulator.getFieldMeta
386386
getFieldValue<TField>(field): DeepValue<TFormData, TField>;
387387
```
388388
389-
Defined in: [packages/form-core/src/FormApi.ts:2184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2184)
389+
Defined in: [packages/form-core/src/FormApi.ts:2189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2189)
390390
391391
Gets the value of the specified field.
392392
@@ -422,7 +422,7 @@ FieldManipulator.getFieldValue
422422
handleSubmit(): Promise<void>;
423423
```
424424
425-
Defined in: [packages/form-core/src/FormApi.ts:2029](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2029)
425+
Defined in: [packages/form-core/src/FormApi.ts:2034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2034)
426426
427427
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
428428
@@ -442,7 +442,7 @@ FieldManipulator.handleSubmit
442442
handleSubmit(submitMeta): Promise<void>;
443443
```
444444
445-
Defined in: [packages/form-core/src/FormApi.ts:2030](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2030)
445+
Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035)
446446
447447
##### Parameters
448448
@@ -472,7 +472,7 @@ insertFieldValue<TField>(
472472
options?): Promise<void>;
473473
```
474474
475-
Defined in: [packages/form-core/src/FormApi.ts:2335](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2335)
475+
Defined in: [packages/form-core/src/FormApi.ts:2340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2340)
476476
477477
#### Type Parameters
478478
@@ -540,7 +540,7 @@ moveFieldValues<TField>(
540540
options?): void;
541541
```
542542
543-
Defined in: [packages/form-core/src/FormApi.ts:2473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2473)
543+
Defined in: [packages/form-core/src/FormApi.ts:2478](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2478)
544544
545545
Moves the value at the first specified index to the second specified index within an array field.
546546
@@ -591,7 +591,7 @@ parseValuesWithSchema(schema):
591591
| undefined;
592592
```
593593
594-
Defined in: [packages/form-core/src/FormApi.ts:2684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2684)
594+
Defined in: [packages/form-core/src/FormApi.ts:2689](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2689)
595595
596596
Parses the form's values with a given standard schema and returns
597597
issues (if any). This method does NOT set any internal errors.
@@ -625,7 +625,7 @@ parseValuesWithSchemaAsync(schema): Promise<
625625
| undefined>;
626626
```
627627
628-
Defined in: [packages/form-core/src/FormApi.ts:2696](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2696)
628+
Defined in: [packages/form-core/src/FormApi.ts:2701](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2701)
629629
630630
Parses the form's values with a given standard schema and returns
631631
issues (if any). This method does NOT set any internal errors.
@@ -658,7 +658,7 @@ pushFieldValue<TField>(
658658
options?): void;
659659
```
660660
661-
Defined in: [packages/form-core/src/FormApi.ts:2321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2321)
661+
Defined in: [packages/form-core/src/FormApi.ts:2326](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2326)
662662
663663
Pushes a value into an array field.
664664
@@ -703,7 +703,7 @@ removeFieldValue<TField>(
703703
options?): Promise<void>;
704704
```
705705
706-
Defined in: [packages/form-core/src/FormApi.ts:2401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2401)
706+
Defined in: [packages/form-core/src/FormApi.ts:2406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2406)
707707
708708
Removes a value from an array field at the specified index.
709709
@@ -749,7 +749,7 @@ replaceFieldValue<TField>(
749749
options?): Promise<void>;
750750
```
751751
752-
Defined in: [packages/form-core/src/FormApi.ts:2372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2372)
752+
Defined in: [packages/form-core/src/FormApi.ts:2377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2377)
753753
754754
Replaces a value into an array field at the specified index.
755755
@@ -828,7 +828,7 @@ Optional options to control the reset behavior.
828828
resetField<TField>(field): void;
829829
```
830830
831-
Defined in: [packages/form-core/src/FormApi.ts:2538](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2538)
831+
Defined in: [packages/form-core/src/FormApi.ts:2543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2543)
832832
833833
Resets the field value and meta to default state
834834
@@ -862,7 +862,7 @@ FieldManipulator.resetField
862862
resetFieldMeta<TField>(fieldMeta): Partial<Record<TField, AnyFieldMeta>>;
863863
```
864864
865-
Defined in: [packages/form-core/src/FormApi.ts:2241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2241)
865+
Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246)
866866
867867
resets every field's meta
868868
@@ -890,7 +890,7 @@ resets every field's meta
890890
setErrorMap(errorMap): void;
891891
```
892892
893-
Defined in: [packages/form-core/src/FormApi.ts:2556](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2556)
893+
Defined in: [packages/form-core/src/FormApi.ts:2561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2561)
894894
895895
Updates the form's errorMap
896896
@@ -912,7 +912,7 @@ Updates the form's errorMap
912912
setFieldMeta<TField>(field, updater): void;
913913
```
914914
915-
Defined in: [packages/form-core/src/FormApi.ts:2220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2220)
915+
Defined in: [packages/form-core/src/FormApi.ts:2225](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2225)
916916
917917
Updates the metadata of the specified field.
918918
@@ -953,7 +953,7 @@ setFieldValue<TField>(
953953
opts?): void;
954954
```
955955
956-
Defined in: [packages/form-core/src/FormApi.ts:2257](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2257)
956+
Defined in: [packages/form-core/src/FormApi.ts:2262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2262)
957957
958958
Sets the value of the specified field and optionally updates the touched state.
959959
@@ -999,7 +999,7 @@ swapFieldValues<TField>(
999999
options?): void;
10001000
```
10011001
1002-
Defined in: [packages/form-core/src/FormApi.ts:2441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2441)
1002+
Defined in: [packages/form-core/src/FormApi.ts:2446](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2446)
10031003
10041004
Swaps the values at the specified indices within an array field.
10051005

0 commit comments

Comments
 (0)