Skip to content

Commit 9111674

Browse files
ci: apply automated fixes and generate docs
1 parent 9ed9be6 commit 9111674

17 files changed

+119
-100
lines changed

docs/reference/classes/formapi.md

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

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ title: "@tanstack/form-core"
5151
- [DeepRecord](../type-aliases/deeprecord.md)
5252
- [DeepValue](../type-aliases/deepvalue.md)
5353
- [DerivedFormState](../type-aliases/derivedformstate.md)
54+
- [ExtractGlobalFormError](../type-aliases/extractglobalformerror.md)
5455
- [FieldInfo](../type-aliases/fieldinfo.md)
5556
- [FieldMeta](../type-aliases/fieldmeta.md)
5657
- [FieldMetaBase](../type-aliases/fieldmetabase.md)

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, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FormApi.ts:241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L241)
10+
Defined in: [packages/form-core/src/FormApi.ts:242](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L242)
1111

1212
## Type Parameters
1313

@@ -39,7 +39,7 @@ Defined in: [packages/form-core/src/FormApi.ts:241](https://github.com/TanStack/
3939
optional onBlur: (props) => void;
4040
```
4141

42-
Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270)
42+
Defined in: [packages/form-core/src/FormApi.ts:271](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L271)
4343

4444
#### Parameters
4545

@@ -65,7 +65,7 @@ Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/
6565
optional onBlurDebounceMs: number;
6666
```
6767

68-
Defined in: [packages/form-core/src/FormApi.ts:285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L285)
68+
Defined in: [packages/form-core/src/FormApi.ts:286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L286)
6969

7070
***
7171

@@ -75,7 +75,7 @@ Defined in: [packages/form-core/src/FormApi.ts:285](https://github.com/TanStack/
7575
optional onChange: (props) => void;
7676
```
7777

78-
Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L253)
78+
Defined in: [packages/form-core/src/FormApi.ts:254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L254)
7979

8080
#### Parameters
8181

@@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/TanStack/
101101
optional onChangeDebounceMs: number;
102102
```
103103

104-
Defined in: [packages/form-core/src/FormApi.ts:268](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L268)
104+
Defined in: [packages/form-core/src/FormApi.ts:269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L269)
105105

106106
***
107107

@@ -111,7 +111,7 @@ Defined in: [packages/form-core/src/FormApi.ts:268](https://github.com/TanStack/
111111
optional onMount: (props) => void;
112112
```
113113

114-
Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L287)
114+
Defined in: [packages/form-core/src/FormApi.ts:288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L288)
115115

116116
#### Parameters
117117

@@ -133,7 +133,7 @@ Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/
133133
optional onSubmit: (props) => void;
134134
```
135135

136-
Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L302)
136+
Defined in: [packages/form-core/src/FormApi.ts:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L303)
137137

138138
#### Parameters
139139

docs/reference/interfaces/formoptions.md

Lines changed: 12 additions & 12 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, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L321)
10+
Defined in: [packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L322)
1111

1212
An object representing the options for a form.
1313

@@ -41,7 +41,7 @@ An object representing the options for a form.
4141
optional asyncAlways: boolean;
4242
```
4343

44-
Defined in: [packages/form-core/src/FormApi.ts:356](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L356)
44+
Defined in: [packages/form-core/src/FormApi.ts:357](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L357)
4545

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

@@ -53,7 +53,7 @@ If true, always run async validation, even when sync validation has produced an
5353
optional asyncDebounceMs: number;
5454
```
5555

56-
Defined in: [packages/form-core/src/FormApi.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360)
56+
Defined in: [packages/form-core/src/FormApi.ts:361](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L361)
5757

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

@@ -65,7 +65,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
6565
optional canSubmitWhenInvalid: boolean;
6666
```
6767

68-
Defined in: [packages/form-core/src/FormApi.ts:364](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L364)
68+
Defined in: [packages/form-core/src/FormApi.ts:365](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365)
6969

7070
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.
7171

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

80-
Defined in: [packages/form-core/src/FormApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L340)
80+
Defined in: [packages/form-core/src/FormApi.ts:341](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L341)
8181

8282
The default state for the form.
8383

@@ -89,7 +89,7 @@ The default state for the form.
8989
optional defaultValues: TFormData;
9090
```
9191

92-
Defined in: [packages/form-core/src/FormApi.ts:336](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L336)
92+
Defined in: [packages/form-core/src/FormApi.ts:337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L337)
9393

9494
Set initial values for your form.
9595

@@ -101,7 +101,7 @@ Set initial values for your form.
101101
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;
102102
```
103103

104-
Defined in: [packages/form-core/src/FormApi.ts:387](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L387)
104+
Defined in: [packages/form-core/src/FormApi.ts:388](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L388)
105105

106106
form level listeners
107107

@@ -113,7 +113,7 @@ form level listeners
113113
optional onSubmit: (props) => any;
114114
```
115115

116-
Defined in: [packages/form-core/src/FormApi.ts:403](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L403)
116+
Defined in: [packages/form-core/src/FormApi.ts:404](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L404)
117117

118118
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>`
119119

@@ -145,7 +145,7 @@ A function to be called when the form is submitted, what should happen once the
145145
optional onSubmitInvalid: (props) => void;
146146
```
147147

148-
Defined in: [packages/form-core/src/FormApi.ts:422](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L422)
148+
Defined in: [packages/form-core/src/FormApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L423)
149149

150150
Specify an action for scenarios where the user tries to submit an invalid form.
151151

@@ -173,7 +173,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
173173
optional onSubmitMeta: TSubmitMeta;
174174
```
175175

176-
Defined in: [packages/form-core/src/FormApi.ts:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382)
176+
Defined in: [packages/form-core/src/FormApi.ts:383](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L383)
177177

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

@@ -185,7 +185,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
185185
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
186186
```
187187

188-
Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L437)
188+
Defined in: [packages/form-core/src/FormApi.ts:438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438)
189189

190190
***
191191

@@ -195,6 +195,6 @@ Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/TanStack/
195195
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>;
196196
```
197197

198-
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
198+
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
199199

200200
A list of validators to pass to the form

0 commit comments

Comments
 (0)