Skip to content

Commit f4bc8d1

Browse files
ci: apply automated fixes and generate docs
1 parent c2ecf5d commit f4bc8d1

25 files changed

+166
-143
lines changed

docs/reference/classes/FormApi.md

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

docs/reference/functions/createFieldMap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFieldMap
99
function createFieldMap<T>(values): { [K in string | number | symbol]: K };
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:540](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L540)
12+
Defined in: [packages/form-core/src/utils.ts:541](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L541)
1313

1414
## Type Parameters
1515

docs/reference/functions/evaluate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: evaluate
99
function evaluate<T>(objA, objB): boolean;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L423)
12+
Defined in: [packages/form-core/src/utils.ts:424](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L424)
1313

1414
## Type Parameters
1515

docs/reference/functions/isGlobalFormValidationError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: isGlobalFormValidationError
99
function isGlobalFormValidationError(error): error is GlobalFormValidationError<unknown>;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L417)
12+
Defined in: [packages/form-core/src/utils.ts:418](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L418)
1313

1414
## Parameters
1515

docs/reference/functions/uuid.md

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

12-
Defined in: [packages/form-core/src/utils.ts:579](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L579)
12+
Defined in: [packages/form-core/src/utils.ts:580](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L580)
1313

1414
## Returns
1515

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ title: "@tanstack/form-core"
9696
- [defaultValidationLogic](variables/defaultValidationLogic.md)
9797
- [formEventClient](variables/formEventClient.md)
9898
- [standardSchemaValidators](variables/standardSchemaValidators.md)
99+
- [throttleFormState](variables/throttleFormState.md)
99100

100101
## Functions
101102

docs/reference/interfaces/BaseFormOptions.md

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

66
# Interface: BaseFormOptions\<TFormData, TSubmitMeta\>
77

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

1010
An object representing the base properties of a form, unrelated to any validators
1111

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

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

3636
Set initial values for your form.
3737

@@ -43,6 +43,6 @@ Set initial values for your form.
4343
optional onSubmitMeta: TSubmitMeta;
4444
```
4545

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

4848
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
@@ -5,7 +5,7 @@ title: FormListeners
55

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

8-
Defined in: [packages/form-core/src/FormApi.ts:269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L269)
8+
Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270)
99

1010
## Type Parameters
1111

@@ -65,7 +65,7 @@ Defined in: [packages/form-core/src/FormApi.ts:269](https://github.com/TanStack/
6565
optional onBlur: (props) => void;
6666
```
6767

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

7070
#### Parameters
7171

@@ -91,7 +91,7 @@ Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/TanStack/
9191
optional onBlurDebounceMs: number;
9292
```
9393

94-
Defined in: [packages/form-core/src/FormApi.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L319)
94+
Defined in: [packages/form-core/src/FormApi.ts:320](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L320)
9595

9696
***
9797

@@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:319](https://github.com/TanStack/
101101
optional onChange: (props) => void;
102102
```
103103

104-
Defined in: [packages/form-core/src/FormApi.ts:283](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L283)
104+
Defined in: [packages/form-core/src/FormApi.ts:284](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L284)
105105

106106
#### Parameters
107107

@@ -127,7 +127,7 @@ Defined in: [packages/form-core/src/FormApi.ts:283](https://github.com/TanStack/
127127
optional onChangeDebounceMs: number;
128128
```
129129

130-
Defined in: [packages/form-core/src/FormApi.ts:300](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L300)
130+
Defined in: [packages/form-core/src/FormApi.ts:301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L301)
131131

132132
***
133133

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

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

142142
#### Parameters
143143

@@ -159,7 +159,7 @@ Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/
159159
optional onSubmit: (props) => void;
160160
```
161161

162-
Defined in: [packages/form-core/src/FormApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L338)
162+
Defined in: [packages/form-core/src/FormApi.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L339)
163163

164164
#### Parameters
165165

docs/reference/interfaces/FormOptions.md

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

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

8-
Defined in: [packages/form-core/src/FormApi.ts:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L374)
8+
Defined in: [packages/form-core/src/FormApi.ts:375](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L375)
99

1010
An object representing the options for a form.
1111

@@ -71,7 +71,7 @@ An object representing the options for a form.
7171
optional asyncAlways: boolean;
7272
```
7373

74-
Defined in: [packages/form-core/src/FormApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L413)
74+
Defined in: [packages/form-core/src/FormApi.ts:414](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L414)
7575

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

@@ -83,7 +83,7 @@ If true, always run async validation, even when sync validation has produced an
8383
optional asyncDebounceMs: number;
8484
```
8585

86-
Defined in: [packages/form-core/src/FormApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L417)
86+
Defined in: [packages/form-core/src/FormApi.ts:418](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L418)
8787

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

@@ -95,7 +95,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
9595
optional canSubmitWhenInvalid: boolean;
9696
```
9797

98-
Defined in: [packages/form-core/src/FormApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L421)
98+
Defined in: [packages/form-core/src/FormApi.ts:422](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L422)
9999

100100
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.
101101

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

110-
Defined in: [packages/form-core/src/FormApi.ts:395](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L395)
110+
Defined in: [packages/form-core/src/FormApi.ts:396](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L396)
111111

112112
The default state for the form.
113113

@@ -119,7 +119,7 @@ The default state for the form.
119119
optional defaultValues: TFormData;
120120
```
121121

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

124124
Set initial values for your form.
125125

@@ -135,7 +135,7 @@ Set initial values for your form.
135135
optional formId: string;
136136
```
137137

138-
Defined in: [packages/form-core/src/FormApi.ts:391](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L391)
138+
Defined in: [packages/form-core/src/FormApi.ts:392](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L392)
139139

140140
The form name, used for devtools and identification
141141

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

150-
Defined in: [packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L443)
150+
Defined in: [packages/form-core/src/FormApi.ts:444](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L444)
151151

152152
form level listeners
153153

@@ -159,7 +159,7 @@ form level listeners
159159
optional onSubmit: (props) => any;
160160
```
161161

162-
Defined in: [packages/form-core/src/FormApi.ts:461](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L461)
162+
Defined in: [packages/form-core/src/FormApi.ts:462](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L462)
163163

164164
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>`
165165

@@ -191,7 +191,7 @@ A function to be called when the form is submitted, what should happen once the
191191
optional onSubmitInvalid: (props) => void;
192192
```
193193

194-
Defined in: [packages/form-core/src/FormApi.ts:482](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L482)
194+
Defined in: [packages/form-core/src/FormApi.ts:483](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L483)
195195

196196
Specify an action for scenarios where the user tries to submit an invalid form.
197197

@@ -223,7 +223,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
223223
optional onSubmitMeta: TSubmitMeta;
224224
```
225225

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

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

@@ -239,7 +239,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun
239239
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>>;
240240
```
241241

242-
Defined in: [packages/form-core/src/FormApi.ts:500](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L500)
242+
Defined in: [packages/form-core/src/FormApi.ts:501](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L501)
243243

244244
***
245245

@@ -249,7 +249,7 @@ Defined in: [packages/form-core/src/FormApi.ts:500](https://github.com/TanStack/
249249
optional validationLogic: ValidationLogicFn;
250250
```
251251

252-
Defined in: [packages/form-core/src/FormApi.ts:438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L438)
252+
Defined in: [packages/form-core/src/FormApi.ts:439](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L439)
253253

254254
***
255255

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

262-
Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L425)
262+
Defined in: [packages/form-core/src/FormApi.ts:426](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L426)
263263

264264
A list of validators to pass to the form

0 commit comments

Comments
 (0)