Skip to content

Commit 8eed245

Browse files
ci: apply automated fixes and generate docs
1 parent 94631cb commit 8eed245

28 files changed

+153
-193
lines changed

docs/reference/classes/formapi.md

Lines changed: 36 additions & 36 deletions
Large diffs are not rendered by default.

docs/reference/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@ title: "@tanstack/form-core"
4848
- [AnyFormState](../type-aliases/anyformstate.md)
4949
- [ArrayAccessor](../type-aliases/arrayaccessor.md)
5050
- [BaseFormState](../type-aliases/baseformstate.md)
51+
- [BroadcastFormApi](../type-aliases/broadcastformapi.md)
52+
- [BroadcastFormId](../type-aliases/broadcastformid.md)
5153
- [BroadcastFormState](../type-aliases/broadcastformstate.md)
5254
- [BroadcastFormSubmissionState](../type-aliases/broadcastformsubmissionstate.md)
53-
- [BroadcastFormUnmounted](../type-aliases/broadcastformunmounted.md)
5455
- [DeepKeyAndValueArray](../type-aliases/deepkeyandvaluearray.md)
5556
- [DeepKeyAndValueObject](../type-aliases/deepkeyandvalueobject.md)
5657
- [DeepKeyAndValueTuple](../type-aliases/deepkeyandvaluetuple.md)
@@ -76,9 +77,6 @@ title: "@tanstack/form-core"
7677
- [Nullable](../type-aliases/nullable.md)
7778
- [ObjectAccessor](../type-aliases/objectaccessor.md)
7879
- [ObjectValue](../type-aliases/objectvalue.md)
79-
- [RequestFormForceReset](../type-aliases/requestformforcereset.md)
80-
- [RequestFormReset](../type-aliases/requestformreset.md)
81-
- [RequestFormState](../type-aliases/requestformstate.md)
8280
- [StandardSchemaV1](../type-aliases/standardschemav1.md)
8381
- [TStandardSchemaValidatorIssue](../type-aliases/tstandardschemavalidatorissue.md)
8482
- [TStandardSchemaValidatorValue](../type-aliases/tstandardschemavalidatorvalue.md)

docs/reference/interfaces/baseformoptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: BaseFormOptions
77

88
# Interface: BaseFormOptions\<TFormData, TSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FormApi.ts:365](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365)
10+
Defined in: [packages/form-core/src/FormApi.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360)
1111

1212
An object representing the base properties of a form, unrelated to any validators
1313

@@ -29,7 +29,7 @@ An object representing the base properties of a form, unrelated to any validator
2929
optional defaultValues: TFormData;
3030
```
3131

32-
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
32+
Defined in: [packages/form-core/src/FormApi.ts:364](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L364)
3333

3434
Set initial values for your form.
3535

@@ -41,6 +41,6 @@ Set initial values for your form.
4141
optional onSubmitMeta: TSubmitMeta;
4242
```
4343

44-
Defined in: [packages/form-core/src/FormApi.ts:373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L373)
44+
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
4545

4646
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props

docs/reference/interfaces/formlisteners.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: FormListeners
77

88
# Interface: FormListeners\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274)
10+
Defined in: [packages/form-core/src/FormApi.ts:269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L269)
1111

1212
## Type Parameters
1313

@@ -43,7 +43,7 @@ Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/
4343
optional onBlur: (props) => void;
4444
```
4545

46-
Defined in: [packages/form-core/src/FormApi.ts:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L307)
46+
Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L302)
4747

4848
#### Parameters
4949

@@ -69,7 +69,7 @@ Defined in: [packages/form-core/src/FormApi.ts:307](https://github.com/TanStack/
6969
optional onBlurDebounceMs: number;
7070
```
7171

72-
Defined in: [packages/form-core/src/FormApi.ts:324](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L324)
72+
Defined in: [packages/form-core/src/FormApi.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L319)
7373

7474
***
7575

@@ -79,7 +79,7 @@ Defined in: [packages/form-core/src/FormApi.ts:324](https://github.com/TanStack/
7979
optional onChange: (props) => void;
8080
```
8181

82-
Defined in: [packages/form-core/src/FormApi.ts:288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L288)
82+
Defined in: [packages/form-core/src/FormApi.ts:283](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L283)
8383

8484
#### Parameters
8585

@@ -105,7 +105,7 @@ Defined in: [packages/form-core/src/FormApi.ts:288](https://github.com/TanStack/
105105
optional onChangeDebounceMs: number;
106106
```
107107

108-
Defined in: [packages/form-core/src/FormApi.ts:305](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L305)
108+
Defined in: [packages/form-core/src/FormApi.ts:300](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L300)
109109

110110
***
111111

@@ -115,7 +115,7 @@ Defined in: [packages/form-core/src/FormApi.ts:305](https://github.com/TanStack/
115115
optional onMount: (props) => void;
116116
```
117117

118-
Defined in: [packages/form-core/src/FormApi.ts:326](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L326)
118+
Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L321)
119119

120120
#### Parameters
121121

@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:326](https://github.com/TanStack/
137137
optional onSubmit: (props) => void;
138138
```
139139

140-
Defined in: [packages/form-core/src/FormApi.ts:343](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L343)
140+
Defined in: [packages/form-core/src/FormApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L338)
141141

142142
#### Parameters
143143

docs/reference/interfaces/formoptions.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: FormOptions
77

88
# Interface: FormOptions\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FormApi.ts:379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L379)
10+
Defined in: [packages/form-core/src/FormApi.ts:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L374)
1111

1212
An object representing the options for a form.
1313

@@ -49,7 +49,7 @@ An object representing the options for a form.
4949
optional asyncAlways: boolean;
5050
```
5151

52-
Defined in: [packages/form-core/src/FormApi.ts:418](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L418)
52+
Defined in: [packages/form-core/src/FormApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L413)
5353

5454
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
5555

@@ -61,7 +61,7 @@ If true, always run async validation, even when sync validation has produced an
6161
optional asyncDebounceMs: number;
6262
```
6363

64-
Defined in: [packages/form-core/src/FormApi.ts:422](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L422)
64+
Defined in: [packages/form-core/src/FormApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L417)
6565

6666
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
6767

@@ -73,7 +73,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
7373
optional canSubmitWhenInvalid: boolean;
7474
```
7575

76-
Defined in: [packages/form-core/src/FormApi.ts:426](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L426)
76+
Defined in: [packages/form-core/src/FormApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L421)
7777

7878
If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.
7979

@@ -85,7 +85,7 @@ If true, allows the form to be submitted in an invalid state i.e. canSubmit will
8585
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
8686
```
8787

88-
Defined in: [packages/form-core/src/FormApi.ts:400](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L400)
88+
Defined in: [packages/form-core/src/FormApi.ts:395](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L395)
8989

9090
The default state for the form.
9191

@@ -97,7 +97,7 @@ The default state for the form.
9797
optional defaultValues: TFormData;
9898
```
9999

100-
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
100+
Defined in: [packages/form-core/src/FormApi.ts:364](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L364)
101101

102102
Set initial values for your form.
103103

@@ -113,7 +113,7 @@ Set initial values for your form.
113113
optional formId: string;
114114
```
115115

116-
Defined in: [packages/form-core/src/FormApi.ts:396](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L396)
116+
Defined in: [packages/form-core/src/FormApi.ts:391](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L391)
117117

118118
The form name, used for devtools and identification
119119

@@ -125,7 +125,7 @@ The form name, used for devtools and identification
125125
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
126126
```
127127

128-
Defined in: [packages/form-core/src/FormApi.ts:448](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L448)
128+
Defined in: [packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L443)
129129

130130
form level listeners
131131

@@ -137,7 +137,7 @@ form level listeners
137137
optional onSubmit: (props) => any;
138138
```
139139

140-
Defined in: [packages/form-core/src/FormApi.ts:466](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L466)
140+
Defined in: [packages/form-core/src/FormApi.ts:461](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L461)
141141

142142
A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise<any>`
143143

@@ -169,7 +169,7 @@ A function to be called when the form is submitted, what should happen once the
169169
optional onSubmitInvalid: (props) => void;
170170
```
171171

172-
Defined in: [packages/form-core/src/FormApi.ts:487](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L487)
172+
Defined in: [packages/form-core/src/FormApi.ts:482](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L482)
173173

174174
Specify an action for scenarios where the user tries to submit an invalid form.
175175

@@ -201,7 +201,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
201201
optional onSubmitMeta: TSubmitMeta;
202202
```
203203

204-
Defined in: [packages/form-core/src/FormApi.ts:373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L373)
204+
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
205205

206206
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
207207

@@ -217,7 +217,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
217217
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
218218
```
219219

220-
Defined in: [packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L505)
220+
Defined in: [packages/form-core/src/FormApi.ts:500](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L500)
221221

222222
***
223223

@@ -227,7 +227,7 @@ Defined in: [packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/
227227
optional validationLogic: ValidationLogicFn;
228228
```
229229

230-
Defined in: [packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L443)
230+
Defined in: [packages/form-core/src/FormApi.ts:438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438)
231231

232232
***
233233

@@ -237,6 +237,6 @@ Defined in: [packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/
237237
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
238238
```
239239

240-
Defined in: [packages/form-core/src/FormApi.ts:430](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L430)
240+
Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L425)
241241

242242
A list of validators to pass to the form

0 commit comments

Comments
 (0)