From c9ea6cfd4b8b88e128b53ea4fc2646e10a459a27 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sat, 11 Jan 2025 10:05:33 +0000 Subject: [PATCH] ci: apply automated fixes and generate docs --- .../solid/reference/functions/createfield.md | 38 ++++++++++++++++-- .../solid/reference/functions/createform.md | 24 +++++++++-- .../solid/reference/functions/field.md | 36 +++++++++++++++-- .../reference/interfaces/solidformapi.md | 34 +++++++++++----- .../reference/type-aliases/createfield.md | 40 ++++++++++++++++--- .../reference/type-aliases/fieldcomponent.md | 38 ++++++++++++++++-- 6 files changed, 181 insertions(+), 29 deletions(-) diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md index 6befedc54..5d9cff398 100644 --- a/docs/framework/solid/reference/functions/createfield.md +++ b/docs/framework/solid/reference/functions/createfield.md @@ -6,10 +6,10 @@ title: createField # Function: createField() ```ts -function createField(opts): () => never +function createField(opts): () => FieldApi & SolidFieldApi ``` -Defined in: [packages/solid-form/src/createField.tsx:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L87) +Defined in: [packages/solid-form/src/createField.tsx:237](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L237) ## Type Parameters @@ -25,11 +25,41 @@ Defined in: [packages/solid-form/src/createField.tsx:87](https://github.com/TanS • **TData** = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Parameters ### opts -() => `CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +() => `CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> ## Returns @@ -37,4 +67,4 @@ Defined in: [packages/solid-form/src/createField.tsx:87](https://github.com/TanS ### Returns -`never` +`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md index 4408204c0..95ed8a408 100644 --- a/docs/framework/solid/reference/functions/createform.md +++ b/docs/framework/solid/reference/functions/createform.md @@ -6,10 +6,10 @@ title: createForm # Function: createForm() ```ts -function createForm(opts?): FormApi & SolidFormApi +function createForm(opts?): FormApi & SolidFormApi ``` -Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L26) +Defined in: [packages/solid-form/src/createForm.tsx:112](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L112) ## Type Parameters @@ -17,12 +17,28 @@ Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/TanSt • **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Parameters ### opts? -() => `FormOptions`\<`TParentData`, `TFormValidator`\> +() => `FormOptions`\<`TParentData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> ## Returns -`FormApi`\<`TParentData`, `TFormValidator`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormValidator`\> +`FormApi`\<`TParentData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md index 7cb6956d1..d1b9bc3a5 100644 --- a/docs/framework/solid/reference/functions/field.md +++ b/docs/framework/solid/reference/functions/field.md @@ -6,10 +6,10 @@ title: Field # Function: Field() ```ts -function Field(props): Element +function Field(props): Element ``` -Defined in: [packages/solid-form/src/createField.tsx:196](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L196) +Defined in: [packages/solid-form/src/createField.tsx:483](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L483) ## Type Parameters @@ -25,11 +25,41 @@ Defined in: [packages/solid-form/src/createField.tsx:196](https://github.com/Tan • **TData** = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Parameters ### props -`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` +`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & `object` ## Returns diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md index a0ae50053..b06040e3c 100644 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ b/docs/framework/solid/reference/interfaces/solidformapi.md @@ -3,7 +3,7 @@ id: SolidFormApi title: SolidFormApi --- -# Interface: SolidFormApi\ +# Interface: SolidFormApi\ Defined in: [packages/solid-form/src/createForm.tsx:11](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L11) @@ -13,25 +13,41 @@ Defined in: [packages/solid-form/src/createForm.tsx:11](https://github.com/TanSt • **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Properties ### createField ```ts -createField: CreateField; +createField: CreateField; ``` -Defined in: [packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) +Defined in: [packages/solid-form/src/createForm.tsx:35](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L35) *** ### Field ```ts -Field: FieldComponent; +Field: FieldComponent; ``` -Defined in: [packages/solid-form/src/createForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L15) +Defined in: [packages/solid-form/src/createForm.tsx:23](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L23) *** @@ -41,11 +57,11 @@ Defined in: [packages/solid-form/src/createForm.tsx:15](https://github.com/TanSt Subscribe: (props) => Element; ``` -Defined in: [packages/solid-form/src/createForm.tsx:20](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L20) +Defined in: [packages/solid-form/src/createForm.tsx:78](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L78) #### Type Parameters -• **TSelected** = `FormState`\<`TFormData`\> +• **TSelected** = `FormState`\<`TFormData`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> #### Parameters @@ -71,11 +87,11 @@ Defined in: [packages/solid-form/src/createForm.tsx:20](https://github.com/TanSt useStore: (selector?) => () => TSelected; ``` -Defined in: [packages/solid-form/src/createForm.tsx:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L17) +Defined in: [packages/solid-form/src/createForm.tsx:47](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L47) #### Type Parameters -• **TSelected** = `FormState`\<`TFormData`\> +• **TSelected** = `FormState`\<`TFormData`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> #### Parameters diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md index 3c91dcf69..00abc4f6e 100644 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -3,13 +3,13 @@ id: CreateField title: CreateField --- -# Type Alias: CreateField()\ +# Type Alias: CreateField()\ ```ts -type CreateField = (opts) => () => FieldApi & SolidFieldApi; +type CreateField = (opts) => () => FieldApi & SolidFieldApi; ``` -Defined in: [packages/solid-form/src/createField.tsx:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L29) +Defined in: [packages/solid-form/src/createField.tsx:48](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L48) ## Type Parameters @@ -17,6 +17,22 @@ Defined in: [packages/solid-form/src/createField.tsx:29](https://github.com/TanS • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Type Parameters • **TName** *extends* `DeepKeys`\<`TParentData`\> @@ -27,11 +43,25 @@ Defined in: [packages/solid-form/src/createField.tsx:29](https://github.com/TanS • **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + ## Parameters ### opts -() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> +() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>, `"form"`\> ## Returns @@ -39,4 +69,4 @@ Defined in: [packages/solid-form/src/createField.tsx:29](https://github.com/TanS ### Returns -`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`\> +`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md index d0464a4ea..d945a8aff 100644 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -3,16 +3,16 @@ id: FieldComponent title: FieldComponent --- -# Type Alias: FieldComponent()\ +# Type Alias: FieldComponent()\ ```ts -type FieldComponent = ({ +type FieldComponent = ({ children, ...fieldOptions }) => JSXElement; ``` -Defined in: [packages/solid-form/src/createField.tsx:171](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L171) +Defined in: [packages/solid-form/src/createField.tsx:428](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L428) ## Type Parameters @@ -20,6 +20,22 @@ Defined in: [packages/solid-form/src/createField.tsx:171](https://github.com/Tan • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Type Parameters • **TName** *extends* `DeepKeys`\<`TParentData`\> @@ -30,6 +46,20 @@ Defined in: [packages/solid-form/src/createField.tsx:171](https://github.com/Tan • **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + ## Parameters ### \{ @@ -37,7 +67,7 @@ Defined in: [packages/solid-form/src/createField.tsx:171](https://github.com/Tan ...fieldOptions \} -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> +`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>, `"form"`\> ## Returns