ci: apply automated fixes and generate docs

TanStack · Feb 22, 2025 · e7db6c6 · e7db6c6
1 parent dfeb6ab
commit e7db6c6
Show file tree

Hide file tree

Showing 81 changed files with 162 additions and 0 deletions.
diff --git a/docs/framework/angular/reference/classes/tanstackfield.md b/docs/framework/angular/reference/classes/tanstackfield.md
@@ -3,6 +3,8 @@ id: TanStackField
 title: TanStackField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Class: TanStackField\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [tanstack-field.directive.ts:32](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L32)

diff --git a/docs/framework/angular/reference/functions/injectform.md b/docs/framework/angular/reference/functions/injectform.md
@@ -3,6 +3,8 @@ id: injectForm
 title: injectForm
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectForm()
 
 ```ts

diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md
@@ -3,6 +3,8 @@ id: injectStore
 title: injectStore
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectStore()
 
 ```ts

diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/angular-form"
 title: "@tanstack/angular-form"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/angular-form
 
 ## Classes

diff --git a/docs/framework/lit/reference/classes/tanstackformcontroller.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md
@@ -3,6 +3,8 @@ id: TanStackFormController
 title: TanStackFormController
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Class: TanStackFormController\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [tanstack-form-controller.ts:183](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L183)

diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/lit-form"
 title: "@tanstack/lit-form"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/lit-form
 
 ## Classes

diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md
@@ -3,6 +3,8 @@ id: Field
 title: Field
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: Field()
 
 ```ts

diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md
@@ -3,6 +3,8 @@ id: useField
 title: useField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useField()
 
 ```ts

diff --git a/docs/framework/react/reference/functions/useform.md b/docs/framework/react/reference/functions/useform.md
@@ -3,6 +3,8 @@ id: useForm
 title: useForm
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useForm()
 
 ```ts

diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md
@@ -3,6 +3,8 @@ id: useStore
 title: useStore
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useStore()
 
 ## Call Signature

diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md
@@ -3,6 +3,8 @@ id: useTransform
 title: useTransform
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useTransform()
 
 ```ts

diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/react-form"
 title: "@tanstack/react-form"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/react-form
 
 ## Interfaces

diff --git a/docs/framework/react/reference/interfaces/reactformapi.md b/docs/framework/react/reference/interfaces/reactformapi.md
@@ -3,6 +3,8 @@ id: ReactFormApi
 title: ReactFormApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: ReactFormApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer\>
 
 Defined in: [packages/react-form/src/useForm.tsx:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L21)

diff --git a/docs/framework/react/reference/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md
@@ -3,6 +3,8 @@ id: FieldComponent
 title: FieldComponent
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: FieldComponent()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/react/reference/type-aliases/reactformextendedapi.md b/docs/framework/react/reference/type-aliases/reactformextendedapi.md
@@ -3,6 +3,8 @@ id: ReactFormExtendedApi
 title: ReactFormExtendedApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: ReactFormExtendedApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer\>
 
 ```ts

diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md
@@ -3,6 +3,8 @@ id: UseField
 title: UseField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: UseField()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md
@@ -3,6 +3,8 @@ id: createField
 title: createField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: createField()
 
 ```ts

diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md
@@ -3,6 +3,8 @@ id: createForm
 title: createForm
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: createForm()
 
 ```ts

diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md
@@ -3,6 +3,8 @@ id: Field
 title: Field
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: Field()
 
 ```ts

diff --git a/docs/framework/solid/reference/functions/usestore.md b/docs/framework/solid/reference/functions/usestore.md
@@ -3,6 +3,8 @@ id: useStore
 title: useStore
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useStore()
 
 ## Call Signature

diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/solid-form"
 title: "@tanstack/solid-form"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/solid-form
 
 ## Interfaces

diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md
@@ -3,6 +3,8 @@ id: SolidFormApi
 title: SolidFormApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: SolidFormApi\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16)

diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md
@@ -3,6 +3,8 @@ id: CreateField
 title: CreateField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: CreateField()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md
@@ -3,6 +3,8 @@ id: FieldComponent
 title: FieldComponent
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: FieldComponent()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md
@@ -3,6 +3,8 @@ id: useField
 title: useField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useField()
 
 ```ts

diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md
@@ -3,6 +3,8 @@ id: useForm
 title: useForm
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useForm()
 
 ```ts

diff --git a/docs/framework/vue/reference/functions/usestore.md b/docs/framework/vue/reference/functions/usestore.md
@@ -3,6 +3,8 @@ id: useStore
 title: useStore
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: useStore()
 
 ## Call Signature

diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/vue-form"
 title: "@tanstack/vue-form"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/vue-form
 
 ## Interfaces

diff --git a/docs/framework/vue/reference/interfaces/vuefieldapi.md b/docs/framework/vue/reference/interfaces/vuefieldapi.md
@@ -3,6 +3,8 @@ id: VueFieldApi
 title: VueFieldApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: VueFieldApi\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [packages/vue-form/src/useField.tsx:159](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L159)

diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md
@@ -3,6 +3,8 @@ id: VueFormApi
 title: VueFormApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: VueFormApi\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [packages/vue-form/src/useForm.tsx:115](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L115)

diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponent.md b/docs/framework/vue/reference/type-aliases/fieldcomponent.md
@@ -3,6 +3,8 @@ id: FieldComponent
 title: FieldComponent
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: FieldComponent()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md
@@ -3,6 +3,8 @@ id: FieldComponentProps
 title: FieldComponentProps
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: FieldComponentProps\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md
@@ -3,6 +3,8 @@ id: UseField
 title: UseField
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Type Alias: UseField()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 ```ts

diff --git a/docs/framework/vue/reference/variables/field.md b/docs/framework/vue/reference/variables/field.md
@@ -3,6 +3,8 @@ id: Field
 title: Field
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Variable: Field()
 
 ```ts

diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md
@@ -3,6 +3,8 @@ id: FieldApi
 title: FieldApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Class: FieldApi\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832)

diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md
@@ -3,6 +3,8 @@ id: FormApi
 title: FormApi
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Class: FormApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer\>
 
 Defined in: [packages/form-core/src/FormApi.ts:622](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L622)

diff --git a/docs/reference/functions/formoptions.md b/docs/reference/functions/formoptions.md
@@ -3,6 +3,8 @@ id: formOptions
 title: formOptions
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: formOptions()
 
 ```ts

diff --git a/docs/reference/functions/isglobalformvalidationerror.md b/docs/reference/functions/isglobalformvalidationerror.md
@@ -3,6 +3,8 @@ id: isGlobalFormValidationError
 title: isGlobalFormValidationError
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: isGlobalFormValidationError()
 
 ```ts

diff --git a/docs/reference/functions/isstandardschemavalidator.md b/docs/reference/functions/isstandardschemavalidator.md
@@ -3,6 +3,8 @@ id: isStandardSchemaValidator
 title: isStandardSchemaValidator
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: isStandardSchemaValidator()
 
 ```ts

diff --git a/docs/reference/functions/mergeform.md b/docs/reference/functions/mergeform.md
@@ -3,6 +3,8 @@ id: mergeForm
 title: mergeForm
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: mergeForm()
 
 ```ts

diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md
@@ -3,6 +3,8 @@ id: shallow
 title: shallow
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: shallow()
 
 ```ts

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -3,6 +3,8 @@ id: "@tanstack/form-core"
 title: "@tanstack/form-core"
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # @tanstack/form-core
 
 ## Classes

diff --git a/docs/reference/interfaces/fieldapioptions.md b/docs/reference/interfaces/fieldapioptions.md
@@ -3,6 +3,8 @@ id: FieldApiOptions
 title: FieldApiOptions
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: FieldApiOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer\>
 
 Defined in: [packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L423)

diff --git a/docs/reference/interfaces/fieldlisteners.md b/docs/reference/interfaces/fieldlisteners.md
@@ -3,6 +3,8 @@ id: FieldListeners
 title: FieldListeners
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Interface: FieldListeners\<TParentData, TName, TData\>
 
 Defined in: [packages/form-core/src/FieldApi.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L323)
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,8 @@ id: injectForm @@
     title: injectForm
     ---
+    <!-- DO NOT EDIT: this page is autogenerated from the type comments -->
     # Function: injectForm()
     ```ts
@@ Expand Down @@