Skip to content

Commit eccf903

Browse files
ci: apply automated fixes and generate docs
1 parent 644b558 commit eccf903

1 file changed

Lines changed: 27 additions & 26 deletions

File tree

docs/reference/classes/FormApi.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Defined in: [packages/form-core/src/FormApi.ts:948](https://github.com/TanStack/
179179
_handleSubmit(submitMeta?): Promise<void>;
180180
```
181181
182-
Defined in: [packages/form-core/src/FormApi.ts:2077](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2077)
182+
Defined in: [packages/form-core/src/FormApi.ts:2081](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2081)
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:2543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2543)
204+
Defined in: [packages/form-core/src/FormApi.ts:2547](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2547)
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:2335](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2335)
242+
Defined in: [packages/form-core/src/FormApi.ts:2339](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2339)
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:2658](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2658)
274+
Defined in: [packages/form-core/src/FormApi.ts:2662](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2662)
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:2239](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2239)
327+
Defined in: [packages/form-core/src/FormApi.ts:2243](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2243)
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:2230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2230)
355+
Defined in: [packages/form-core/src/FormApi.ts:2234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2234)
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:2223](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2223)
389+
Defined in: [packages/form-core/src/FormApi.ts:2227](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2227)
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:2068](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2068)
425+
Defined in: [packages/form-core/src/FormApi.ts:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072)
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:2069](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2069)
445+
Defined in: [packages/form-core/src/FormApi.ts:2073](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2073)
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:2373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2373)
475+
Defined in: [packages/form-core/src/FormApi.ts:2377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2377)
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:2511](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2511)
543+
Defined in: [packages/form-core/src/FormApi.ts:2515](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2515)
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:2722](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2722)
594+
Defined in: [packages/form-core/src/FormApi.ts:2726](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2726)
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:2734](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2734)
628+
Defined in: [packages/form-core/src/FormApi.ts:2738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2738)
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:2359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2359)
661+
Defined in: [packages/form-core/src/FormApi.ts:2363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2363)
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:2439](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2439)
706+
Defined in: [packages/form-core/src/FormApi.ts:2443](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2443)
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:2410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2410)
752+
Defined in: [packages/form-core/src/FormApi.ts:2414](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2414)
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:2576](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2576)
831+
Defined in: [packages/form-core/src/FormApi.ts:2580](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2580)
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:2279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2279)
865+
Defined in: [packages/form-core/src/FormApi.ts:2283](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2283)
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:2594](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2594)
893+
Defined in: [packages/form-core/src/FormApi.ts:2598](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2598)
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:2258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2258)
915+
Defined in: [packages/form-core/src/FormApi.ts:2262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2262)
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:2295](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2295)
956+
Defined in: [packages/form-core/src/FormApi.ts:2299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2299)
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:2479](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2479)
1002+
Defined in: [packages/form-core/src/FormApi.ts:2483](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2483)
10031003
10041004
Swaps the values at the specified indices within an array field.
10051005
@@ -1067,9 +1067,10 @@ Updates the form options and form state.
10671067
validateAllFields(cause): Promise<unknown[]>;
10681068
```
10691069
1070-
Defined in: [packages/form-core/src/FormApi.ts:1549](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1549)
1070+
Defined in: [packages/form-core/src/FormApi.ts:1550](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1550)
10711071
1072-
Validates all fields using the correct handlers for a given validation cause.
1072+
Validates all fields according to the FIELD level validators.
1073+
This will ignore FORM level validators, use form.validate({ValidationCause}) for a complete validation
10731074
10741075
#### Parameters
10751076
@@ -1098,7 +1099,7 @@ validateArrayFieldsStartingFrom<TField>(
10981099
cause): Promise<unknown[]>;
10991100
```
11001101
1101-
Defined in: [packages/form-core/src/FormApi.ts:1579](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1579)
1102+
Defined in: [packages/form-core/src/FormApi.ts:1583](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1583)
11021103
11031104
Validates 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.
11041105
@@ -1140,7 +1141,7 @@ FieldManipulator.validateArrayFieldsStartingFrom
11401141
validateField<TField>(field, cause): any[] | Promise<any[]>;
11411142
```
11421143
1143-
Defined in: [packages/form-core/src/FormApi.ts:1620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1620)
1144+
Defined in: [packages/form-core/src/FormApi.ts:1624](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1624)
11441145
11451146
Validates a specified field in the form using the correct handlers for a given validation type.
11461147

0 commit comments

Comments
 (0)