Skip to content

Commit 638be14

Browse files
ci: apply automated fixes and generate docs
1 parent 7f2453b commit 638be14

File tree

4 files changed

+97
-29
lines changed

4 files changed

+97
-29
lines changed

docs/framework/react/reference/functions/createFormHook.md

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ Defined in: [packages/react-form/src/createFormHook.tsx:293](https://github.com/
2929

3030
## Returns
3131

32-
`object`
33-
3432
### useAppForm()
3533

3634
```ts
@@ -97,6 +95,76 @@ useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsy
9795

9896
`AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
9997

98+
### useTypedAppFormContext()
99+
100+
```ts
101+
useTypedAppFormContext: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(_props) => AppFieldExtendedReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;
102+
```
103+
104+
⚠️ **Use withForm whenever possible.**
105+
106+
Gets a typed form from the `<form.AppForm />` context.
107+
108+
#### Type Parameters
109+
110+
##### TFormData
111+
112+
`TFormData`
113+
114+
##### TOnMount
115+
116+
`TOnMount` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
117+
118+
##### TOnChange
119+
120+
`TOnChange` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
121+
122+
##### TOnChangeAsync
123+
124+
`TOnChangeAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
125+
126+
##### TOnBlur
127+
128+
`TOnBlur` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
129+
130+
##### TOnBlurAsync
131+
132+
`TOnBlurAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
133+
134+
##### TOnSubmit
135+
136+
`TOnSubmit` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
137+
138+
##### TOnSubmitAsync
139+
140+
`TOnSubmitAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
141+
142+
##### TOnDynamic
143+
144+
`TOnDynamic` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
145+
146+
##### TOnDynamicAsync
147+
148+
`TOnDynamicAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
149+
150+
##### TOnServer
151+
152+
`TOnServer` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
153+
154+
##### TSubmitMeta
155+
156+
`TSubmitMeta`
157+
158+
#### Parameters
159+
160+
##### \_props
161+
162+
`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
163+
164+
#### Returns
165+
166+
`AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
167+
100168
### withFieldGroup()
101169

102170
```ts

docs/framework/react/reference/functions/createFormHookContexts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFormHookContexts
99
function createFormHookContexts(): object;
1010
```
1111

12-
Defined in: [packages/react-form/src/createFormHook.tsx:68](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L68)
12+
Defined in: [packages/react-form/src/createFormHook.tsx:95](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L95)
1313

1414
## Returns
1515

docs/reference/classes/FieldGroupApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ FieldManipulator.validateArrayFieldsStartingFrom
830830
### validateField()
831831
832832
```ts
833-
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>;
833+
validateField<TField>(field, cause): any[] | Promise<any[]>;
834834
```
835835
836836
Defined in: [packages/form-core/src/FieldGroupApi.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldGroupApi.ts#L332)
@@ -855,7 +855,7 @@ Validates a specified field in the form using the correct handlers for a given v
855855
856856
#### Returns
857857
858-
`unknown`[] \| `Promise`\<`unknown`[]\>
858+
`any`[] \| `Promise`\<`any`[]\>
859859
860860
#### Implementation of
861861

docs/reference/classes/FormApi.md

Lines changed: 24 additions & 24 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:2043](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2043)
182+
Defined in: [packages/form-core/src/FormApi.ts:2054](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2054)
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:2510](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2510)
204+
Defined in: [packages/form-core/src/FormApi.ts:2521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2521)
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:2302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2302)
242+
Defined in: [packages/form-core/src/FormApi.ts:2313](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2313)
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:2625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2625)
274+
Defined in: [packages/form-core/src/FormApi.ts:2636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2636)
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:2205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2205)
327+
Defined in: [packages/form-core/src/FormApi.ts:2216](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2216)
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:2196](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2196)
355+
Defined in: [packages/form-core/src/FormApi.ts:2207](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2207)
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:2189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2189)
389+
Defined in: [packages/form-core/src/FormApi.ts:2200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2200)
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:2034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2034)
425+
Defined in: [packages/form-core/src/FormApi.ts:2045](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2045)
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:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035)
445+
Defined in: [packages/form-core/src/FormApi.ts:2046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2046)
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:2340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2340)
475+
Defined in: [packages/form-core/src/FormApi.ts:2351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2351)
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:2478](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2478)
543+
Defined in: [packages/form-core/src/FormApi.ts:2489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2489)
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:2689](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2689)
594+
Defined in: [packages/form-core/src/FormApi.ts:2700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2700)
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:2701](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2701)
628+
Defined in: [packages/form-core/src/FormApi.ts:2712](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2712)
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:2326](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2326)
661+
Defined in: [packages/form-core/src/FormApi.ts:2337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2337)
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:2406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2406)
706+
Defined in: [packages/form-core/src/FormApi.ts:2417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2417)
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:2377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2377)
752+
Defined in: [packages/form-core/src/FormApi.ts:2388](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2388)
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:2543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2543)
831+
Defined in: [packages/form-core/src/FormApi.ts:2554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2554)
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:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246)
865+
Defined in: [packages/form-core/src/FormApi.ts:2257](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2257)
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:2561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2561)
893+
Defined in: [packages/form-core/src/FormApi.ts:2572](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2572)
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:2225](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2225)
915+
Defined in: [packages/form-core/src/FormApi.ts:2236](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2236)
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:2262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2262)
956+
Defined in: [packages/form-core/src/FormApi.ts:2273](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2273)
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:2446](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2446)
1002+
Defined in: [packages/form-core/src/FormApi.ts:2457](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2457)
10031003
10041004
Swaps the values at the specified indices within an array field.
10051005
@@ -1137,7 +1137,7 @@ FieldManipulator.validateArrayFieldsStartingFrom
11371137
### validateField()
11381138
11391139
```ts
1140-
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>;
1140+
validateField<TField>(field, cause): any[] | Promise<any[]>;
11411141
```
11421142
11431143
Defined in: [packages/form-core/src/FormApi.ts:1596](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1596)
@@ -1162,7 +1162,7 @@ Validates a specified field in the form using the correct handlers for a given v
11621162
11631163
#### Returns
11641164
1165-
`unknown`[] \| `Promise`\<`unknown`[]\>
1165+
`any`[] \| `Promise`\<`any`[]\>
11661166
11671167
#### Implementation of
11681168

0 commit comments

Comments
 (0)