Skip to content

Commit 424c3c7

Browse files
ci: apply automated fixes and generate docs
1 parent b8476c1 commit 424c3c7

17 files changed

+132
-112
lines changed

docs/reference/classes/formapi.md

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

docs/reference/functions/formoptions.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,44 @@ title: formOptions
88
# Function: formOptions()
99

1010
```ts
11-
function formOptions<TOptions, TFormData, TSubmitMeta>(defaultOpts): TOptions
11+
function formOptions<TOptions, TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(defaultOpts): TOptions
1212
```
1313

1414
Defined in: [packages/form-core/src/formOptions.ts:23](https://github.com/TanStack/form/blob/main/packages/form-core/src/formOptions.ts#L23)
1515

1616
## Type Parameters
1717

18-
**TOptions** *extends* `Partial`\<[`FormOptions`](../../interfaces/formoptions.md)\<`TFormData`, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `TSubmitMeta`\>\>
18+
**TOptions** *extends* `Partial`\<[`FormOptions`](../../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\>
1919

20-
**TFormData** = `TOptions`\[`"defaultValues"`\]
20+
**TFormData**
2121

22-
**TSubmitMeta** = `TOptions`\[`"onSubmitMeta"`\]
22+
**TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
23+
24+
**TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
25+
26+
**TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
27+
28+
**TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
29+
30+
**TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
31+
32+
**TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
33+
34+
**TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
35+
36+
**TOnDynamic** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
37+
38+
**TOnDynamicAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
39+
40+
**TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
41+
42+
**TSubmitMeta** = `never`
2343

2444
## Parameters
2545

2646
### defaultOpts
2747

28-
`Partial`\<[`FormOptions`](../../interfaces/formoptions.md)\<`TFormData`, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>, `TSubmitMeta`\>\> & `TOptions`
48+
`Partial`\<[`FormOptions`](../../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\> & `TOptions`
2949

3050
## Returns
3151

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:351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L351)
10+
Defined in: [packages/form-core/src/FormApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355)
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:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355)
32+
Defined in: [packages/form-core/src/FormApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359)
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:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359)
44+
Defined in: [packages/form-core/src/FormApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L363)
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:260](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L260)
10+
Defined in: [packages/form-core/src/FormApi.ts:264](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L264)
1111

1212
## Type Parameters
1313

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

46-
Defined in: [packages/form-core/src/FormApi.ts:293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L293)
46+
Defined in: [packages/form-core/src/FormApi.ts:297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L297)
4747

4848
#### Parameters
4949

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

72-
Defined in: [packages/form-core/src/FormApi.ts:310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L310)
72+
Defined in: [packages/form-core/src/FormApi.ts:314](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L314)
7373

7474
***
7575

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

82-
Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274)
82+
Defined in: [packages/form-core/src/FormApi.ts:278](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L278)
8383

8484
#### Parameters
8585

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

108-
Defined in: [packages/form-core/src/FormApi.ts:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L291)
108+
Defined in: [packages/form-core/src/FormApi.ts:295](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L295)
109109

110110
***
111111

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

118-
Defined in: [packages/form-core/src/FormApi.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L312)
118+
Defined in: [packages/form-core/src/FormApi.ts:316](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L316)
119119

120120
#### Parameters
121121

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

140-
Defined in: [packages/form-core/src/FormApi.ts:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L329)
140+
Defined in: [packages/form-core/src/FormApi.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L333)
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:365](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365)
10+
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
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:404](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404)
52+
Defined in: [packages/form-core/src/FormApi.ts:408](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408)
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:408](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L408)
64+
Defined in: [packages/form-core/src/FormApi.ts:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412)
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:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L412)
76+
Defined in: [packages/form-core/src/FormApi.ts:416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L416)
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:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L386)
88+
Defined in: [packages/form-core/src/FormApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L390)
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:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355)
100+
Defined in: [packages/form-core/src/FormApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359)
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:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382)
116+
Defined in: [packages/form-core/src/FormApi.ts:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L386)
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:434](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L434)
128+
Defined in: [packages/form-core/src/FormApi.ts:438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438)
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:452](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L452)
140+
Defined in: [packages/form-core/src/FormApi.ts:456](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L456)
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:473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L473)
172+
Defined in: [packages/form-core/src/FormApi.ts:477](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L477)
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:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L359)
204+
Defined in: [packages/form-core/src/FormApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L363)
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:491](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L491)
220+
Defined in: [packages/form-core/src/FormApi.ts:495](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L495)
221221

222222
***
223223

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

230-
Defined in: [packages/form-core/src/FormApi.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L429)
230+
Defined in: [packages/form-core/src/FormApi.ts:433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L433)
231231

232232
***
233233

@@ -237,6 +237,6 @@ Defined in: [packages/form-core/src/FormApi.ts:429](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:416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L416)
240+
Defined in: [packages/form-core/src/FormApi.ts:420](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L420)
241241

242242
A list of validators to pass to the form

0 commit comments

Comments
 (0)