diff --git a/docs/config.json b/docs/config.json index 220237d0a..4dd723e44 100644 --- a/docs/config.json +++ b/docs/config.json @@ -192,40 +192,40 @@ "label": "API Reference", "children": [ { "label": "JavaScript Reference", "to": "reference/index" }, - { "label": "Classes / FieldApi", "to": "reference/FieldApi" }, - { "label": "Classes / FormApi", "to": "reference/FormApi" }, - { "label": "Functions / formOptions", "to": "reference/formOptions" }, - { "label": "Functions / mergeForm", "to": "reference/mergeForm" }, + { "label": "Classes / FieldApi", "to": "reference/classes/fieldapi" }, + { "label": "Classes / FormApi", "to": "reference/classes/formapi" }, + { "label": "Functions / formOptions", "to": "reference/functions/formoptions" }, + { "label": "Functions / mergeForm", "to": "reference/functions/mergeform" }, { "label": "Interfaces / FieldApiOptions", - "to": "reference/FieldApiOptions" + "to": "reference/interfaces/fieldapioptions" }, { "label": "Interfaces / FieldOptions", - "to": "reference/FieldOptions" + "to": "reference/interfaces/fieldoptions" }, { "label": "Interfaces / FieldValidators", - "to": "reference/FieldValidators" + "to": "reference/interfaces/fieldvalidators" }, - { "label": "Interfaces / FormOptions", "to": "reference/FormOptions" }, + { "label": "Interfaces / FormOptions", "to": "reference/interfaces/formoptions" }, { "label": "Interfaces / FormValidators", - "to": "reference/FormValidators" + "to": "reference/interfaces/formvalidators" }, - { "label": "Types / DeepKeys", "to": "reference/DeepKeys" }, - { "label": "Types / DeepValue", "to": "reference/DeepValue" }, - { "label": "Types / FieldInfo", "to": "reference/FieldInfo" }, - { "label": "Types / FieldMeta", "to": "reference/FieldMeta" }, - { "label": "Types / FieldState", "to": "reference/FieldState" }, - { "label": "Types / FormState", "to": "reference/FormState" }, - { "label": "Types / Updater", "to": "reference/Updater" }, - { "label": "Types / UpdaterFn", "to": "reference/UpdaterFn" }, + { "label": "Types / DeepKeys", "to": "reference/type-aliases/deepkeys" }, + { "label": "Types / DeepValue", "to": "reference/type-aliases/deepvalue" }, + { "label": "Types / FieldInfo", "to": "reference/type-aliases/fieldinfo" }, + { "label": "Types / FieldMeta", "to": "reference/type-aliases/fieldmeta" }, + { "label": "Types / FieldState", "to": "reference/type-aliases/fieldstate" }, + { "label": "Types / FormState", "to": "reference/type-aliases/formstate" }, + { "label": "Types / Updater", "to": "reference/type-aliases/updater" }, + { "label": "Types / UpdaterFn", "to": "reference/type-aliases/updaterfn" }, { "label": "Types / ValidationError", - "to": "reference/ValidationError" + "to": "reference/type-aliases/validationerror" }, - { "label": "Types / ValidationMeta", "to": "reference/ValidationMeta" } + { "label": "Types / ValidationMeta", "to": "reference/type-aliases/validationmeta" } ], "frameworks": [ { @@ -237,35 +237,31 @@ }, { "label": "Functions / createServerValidate", - "to": "framework/react/reference/createServerValidate" + "to": "framework/react/reference/functions/createservervalidate" }, { "label": "Functions / Field", - "to": "framework/react/reference/Field" + "to": "framework/react/reference/functions/field" }, { "label": "Functions / useField", - "to": "framework/react/reference/useField" + "to": "framework/react/reference/functions/usefield" }, { "label": "Functions / useForm", - "to": "framework/react/reference/useForm" + "to": "framework/react/reference/functions/useform" }, { "label": "Functions / useTransform", - "to": "framework/react/reference/useTransform" + "to": "framework/react/reference/functions/usetransform" }, { "label": "Types / FieldComponent", - "to": "framework/react/reference/FieldComponent" + "to": "framework/react/reference/type-aliases/fieldcomponent" }, { "label": "Types / UseField", - "to": "framework/react/reference/UseField" - }, - { - "label": "Variables / initialFormState", - "to": "framework/react/reference/initialFormState" + "to": "framework/react/reference/type-aliases/usefield" } ] }, @@ -275,23 +271,23 @@ { "label": "Vue Reference", "to": "framework/vue/reference/index" }, { "label": "Functions / Field", - "to": "framework/vue/reference/Field" + "to": "framework/vue/reference/functions/field" }, { "label": "Functions / useField", - "to": "framework/vue/reference/useField" + "to": "framework/vue/reference/functions/usefield" }, { "label": "Functions / useForm", - "to": "framework/vue/reference/useForm" + "to": "framework/vue/reference/functions/useform" }, { "label": "Types / FieldComponent", - "to": "framework/vue/reference/FieldComponent" + "to": "framework/vue/reference/type-aliases/fieldcomponent" }, { "label": "Types / UseField", - "to": "framework/vue/reference/UseField" + "to": "framework/vue/reference/type-aliases/usefield" } ] }, @@ -304,23 +300,23 @@ }, { "label": "Functions / createField", - "to": "framework/solid/reference/createField" + "to": "framework/solid/reference/functions/createfield" }, { "label": "Functions / createForm", - "to": "framework/solid/reference/createForm" + "to": "framework/solid/reference/functions/createform" }, { "label": "Functions / Field", - "to": "framework/solid/reference/Field" + "to": "framework/solid/reference/functions/field" }, { "label": "Types / CreateField", - "to": "framework/solid/reference/CreateField" + "to": "framework/solid/reference/type-aliases/createfield" }, { "label": "Types / FieldComponent", - "to": "framework/solid/reference/FieldComponent" + "to": "framework/solid/reference/type-aliases/fieldcomponent" } ] }, @@ -330,7 +326,7 @@ { "label": "Lit Reference", "to": "framework/lit/reference/index" }, { "label": "Classes / TanStackFormController", - "to": "framework/lit/reference/TanStackFormController" + "to": "framework/lit/reference/classes/tanstackformcontroller" } ] }, @@ -343,15 +339,15 @@ }, { "label": "Classes / TanStackField", - "to": "framework/angular/reference/TanStackField" + "to": "framework/angular/reference/classes/tanstackfield" }, { "label": "Functions / injectForm", - "to": "framework/angular/reference/injectForm" + "to": "framework/angular/reference/functions/injectform" }, { "label": "Functions / injectStore", - "to": "framework/angular/reference/injectStore" + "to": "framework/angular/reference/functions/injectstore" } ] } diff --git a/docs/framework/angular/reference/TanStackField.md b/docs/framework/angular/reference/classes/tanstackfield.md similarity index 85% rename from docs/framework/angular/reference/TanStackField.md rename to docs/framework/angular/reference/classes/tanstackfield.md index 30a3cb1a9..2a8aa2149 100644 --- a/docs/framework/angular/reference/TanStackField.md +++ b/docs/framework/angular/reference/classes/tanstackfield.md @@ -34,7 +34,7 @@ new TanStackField(): #### Returns -[`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> ## Properties @@ -46,7 +46,7 @@ api: FieldApi; #### Defined in -[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L61) +[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L61) *** @@ -64,7 +64,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L50) +[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L50) *** @@ -82,7 +82,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L49) +[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L49) *** @@ -100,7 +100,7 @@ An optional object with default metadata for the field. #### Defined in -[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L59) +[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L59) *** @@ -118,7 +118,7 @@ An optional default value for the field. #### Defined in -[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L48) +[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L48) *** @@ -136,7 +136,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L44) +[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L44) *** @@ -148,7 +148,7 @@ tanstackField: FormApi; #### Defined in -[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L52) +[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L52) *** @@ -164,7 +164,7 @@ optional unmount: () => void; #### Defined in -[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L76) +[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L76) *** @@ -182,7 +182,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L51) +[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L51) *** @@ -200,7 +200,7 @@ A list of validators to pass to the field #### Defined in -[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L56) +[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L56) ## Methods @@ -225,7 +225,7 @@ children are checked. #### Defined in -[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L88) +[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L88) *** @@ -248,7 +248,7 @@ before a directive, pipe, or service instance is destroyed. #### Defined in -[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L84) +[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L84) *** @@ -274,4 +274,4 @@ It is invoked only once when the directive is instantiated. #### Defined in -[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L78) +[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L78) diff --git a/docs/framework/angular/reference/injectForm.md b/docs/framework/angular/reference/functions/injectform.md similarity index 78% rename from docs/framework/angular/reference/injectForm.md rename to docs/framework/angular/reference/functions/injectform.md index 7e3a30ad9..6b714cdf6 100644 --- a/docs/framework/angular/reference/injectForm.md +++ b/docs/framework/angular/reference/functions/injectform.md @@ -25,4 +25,4 @@ function injectForm(opts?): FormApi(form, selector?): Sig ## Defined in -[inject-store.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-store.ts#L4) +[inject-store.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/inject-store.ts#L4) diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 7c69077c7..aab1d7b1d 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -7,9 +7,9 @@ title: "@tanstack/angular-form" ## Classes -- [TanStackField](TanStackField.md) +- [TanStackField](classes/tanstackfield.md) ## Functions -- [injectForm](injectForm.md) -- [injectStore](injectStore.md) +- [injectForm](functions/injectform.md) +- [injectStore](functions/injectstore.md) diff --git a/docs/framework/lit/reference/TanStackFormController.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md similarity index 88% rename from docs/framework/lit/reference/TanStackFormController.md rename to docs/framework/lit/reference/classes/tanstackformcontroller.md index 0488a548a..817d8d938 100644 --- a/docs/framework/lit/reference/TanStackFormController.md +++ b/docs/framework/lit/reference/classes/tanstackformcontroller.md @@ -31,11 +31,11 @@ new TanStackFormController(host, config?): TanStack #### Returns -[`TanStackFormController`](TanStackFormController.md)\<`TParentData`, `TFormValidator`\> +[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormValidator`\> #### Defined in -[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L93) +[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/lit-form/src/tanstack-form-controller.ts#L93) ## Properties @@ -47,7 +47,7 @@ api: FormApi; #### Defined in -[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L91) +[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/lit-form/src/tanstack-form-controller.ts#L91) ## Methods @@ -101,7 +101,7 @@ render: renderCallback FormApi; ## Defined in -[useTransform.ts:3](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useTransform.ts#L3) +[useTransform.ts:3](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useTransform.ts#L3) diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index d7932ad72..5c67153e1 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -7,12 +7,12 @@ title: "@tanstack/react-form" ## Type Aliases -- [FieldComponent](FieldComponent.md) -- [UseField](UseField.md) +- [FieldComponent](type-aliases/fieldcomponent.md) +- [UseField](type-aliases/usefield.md) ## Functions -- [Field](Field.md) -- [useField](useField.md) -- [useForm](useForm.md) -- [useTransform](useTransform.md) +- [Field](functions/field.md) +- [useField](functions/usefield.md) +- [useForm](functions/useform.md) +- [useTransform](functions/usetransform.md) diff --git a/docs/framework/react/reference/FieldComponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md similarity index 88% rename from docs/framework/react/reference/FieldComponent.md rename to docs/framework/react/reference/type-aliases/fieldcomponent.md index cd4a56690..d76778e89 100644 --- a/docs/framework/react/reference/FieldComponent.md +++ b/docs/framework/react/reference/type-aliases/fieldcomponent.md @@ -41,4 +41,4 @@ A type alias representing a field component for a specific form data type. ## Defined in -[useField.tsx:133](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L133) +[useField.tsx:133](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useField.tsx#L133) diff --git a/docs/framework/react/reference/UseField.md b/docs/framework/react/reference/type-aliases/usefield.md similarity index 90% rename from docs/framework/react/reference/UseField.md rename to docs/framework/react/reference/type-aliases/usefield.md index 9836f2612..a4cf02e60 100644 --- a/docs/framework/react/reference/UseField.md +++ b/docs/framework/react/reference/type-aliases/usefield.md @@ -37,4 +37,4 @@ A function that takes an optional object with a `name` property and field option ## Defined in -[useField.tsx:25](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L25) +[useField.tsx:25](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useField.tsx#L25) diff --git a/docs/framework/solid/reference/createField.md b/docs/framework/solid/reference/functions/createfield.md similarity index 83% rename from docs/framework/solid/reference/createField.md rename to docs/framework/solid/reference/functions/createfield.md index c5cb3cccd..f1b7c58ce 100644 --- a/docs/framework/solid/reference/createField.md +++ b/docs/framework/solid/reference/functions/createfield.md @@ -35,4 +35,4 @@ function createField ## Defined in -[createField.tsx:87](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L87) +[createField.tsx:87](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L87) diff --git a/docs/framework/solid/reference/createForm.md b/docs/framework/solid/reference/functions/createform.md similarity index 80% rename from docs/framework/solid/reference/createForm.md rename to docs/framework/solid/reference/functions/createform.md index 01f192274..181f6a8a3 100644 --- a/docs/framework/solid/reference/createForm.md +++ b/docs/framework/solid/reference/functions/createform.md @@ -25,4 +25,4 @@ function createForm(opts?): FormApi(props ## Defined in -[createField.tsx:185](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L185) +[createField.tsx:185](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L185) diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 75bbd2d08..69b7ef88f 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -7,11 +7,11 @@ title: "@tanstack/solid-form" ## Type Aliases -- [CreateField](CreateField.md) -- [FieldComponent](FieldComponent.md) +- [CreateField](type-aliases/createfield.md) +- [FieldComponent](type-aliases/fieldcomponent.md) ## Functions -- [Field](Field.md) -- [createField](createField.md) -- [createForm](createForm.md) +- [Field](functions/field.md) +- [createField](functions/createfield.md) +- [createForm](functions/createform.md) diff --git a/docs/framework/solid/reference/CreateField.md b/docs/framework/solid/reference/type-aliases/createfield.md similarity index 88% rename from docs/framework/solid/reference/CreateField.md rename to docs/framework/solid/reference/type-aliases/createfield.md index a18ab774c..3edb2b360 100644 --- a/docs/framework/solid/reference/CreateField.md +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -37,4 +37,4 @@ type CreateField: (o ## Defined in -[createField.tsx:29](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L29) +[createField.tsx:29](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L29) diff --git a/docs/framework/solid/reference/FieldComponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md similarity index 88% rename from docs/framework/solid/reference/FieldComponent.md rename to docs/framework/solid/reference/type-aliases/fieldcomponent.md index 05219b5a4..c349bf0c7 100644 --- a/docs/framework/solid/reference/FieldComponent.md +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -39,4 +39,4 @@ type FieldComponent: (props ## Defined in -[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L162) +[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/vue-form/src/useField.tsx#L162) diff --git a/docs/framework/vue/reference/useField.md b/docs/framework/vue/reference/functions/usefield.md similarity index 94% rename from docs/framework/vue/reference/useField.md rename to docs/framework/vue/reference/functions/usefield.md index d7a5b6e8d..43c82ee5c 100644 --- a/docs/framework/vue/reference/useField.md +++ b/docs/framework/vue/reference/functions/usefield.md @@ -43,4 +43,4 @@ readonly state: Readonly>> = fieldState; ## Defined in -[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L49) +[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/vue-form/src/useField.tsx#L49) diff --git a/docs/framework/vue/reference/useForm.md b/docs/framework/vue/reference/functions/useform.md similarity index 90% rename from docs/framework/vue/reference/useForm.md rename to docs/framework/vue/reference/functions/useform.md index e73107b4f..b9abe0ea8 100644 --- a/docs/framework/vue/reference/useForm.md +++ b/docs/framework/vue/reference/functions/useform.md @@ -25,4 +25,4 @@ function useForm(opts?): FormApi: +• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> ## Constructors @@ -37,15 +37,15 @@ Initializes a new `FieldApi` instance. #### Parameters -• **opts**: [`FieldApiOptions`](FieldApiOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +• **opts**: [`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Returns -[`FieldApi`](FieldApi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Defined in -[packages/form-core/src/FieldApi.ts:432](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L432) +[packages/form-core/src/FieldApi.ts:432](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L432) ## Properties @@ -59,7 +59,7 @@ A reference to the form API instance. #### Defined in -[packages/form-core/src/FieldApi.ts:395](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L395) +[packages/form-core/src/FieldApi.ts:395](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L395) *** @@ -73,7 +73,7 @@ The field name. #### Defined in -[packages/form-core/src/FieldApi.ts:405](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L405) +[packages/form-core/src/FieldApi.ts:405](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L405) *** @@ -87,7 +87,7 @@ The field options. #### Defined in -[packages/form-core/src/FieldApi.ts:409](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L409) +[packages/form-core/src/FieldApi.ts:409](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L409) *** @@ -101,7 +101,7 @@ The current field state. #### Defined in -[packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L423) +[packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L423) *** @@ -115,7 +115,7 @@ The field state store. #### Defined in -[packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L419) +[packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L419) ## Methods @@ -129,11 +129,11 @@ Gets the field information object. #### Returns -[`FieldInfo`](FieldInfo.md)\<`TParentData`, `TFormValidator`\> +[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FieldApi.ts:642](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L642) +[packages/form-core/src/FieldApi.ts:642](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L642) *** @@ -147,11 +147,11 @@ Gets the current field metadata. #### Returns -[`FieldMeta`](FieldMeta.md) +[`FieldMeta`](../type-aliases/fieldmeta.md) #### Defined in -[packages/form-core/src/FieldApi.ts:621](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L621) +[packages/form-core/src/FieldApi.ts:621](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L621) *** @@ -173,7 +173,7 @@ Use `field.state.value` instead. #### Defined in -[packages/form-core/src/FieldApi.ts:601](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L601) +[packages/form-core/src/FieldApi.ts:601](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L601) *** @@ -191,7 +191,7 @@ Handles the blur event. #### Defined in -[packages/form-core/src/FieldApi.ts:956](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L956) +[packages/form-core/src/FieldApi.ts:956](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L956) *** @@ -205,7 +205,7 @@ Handles the change event. #### Parameters -• **updater**: [`Updater`](Updater.md)\<`TData`\> +• **updater**: [`Updater`](../type-aliases/updater.md)\<`TData`\> #### Returns @@ -213,7 +213,7 @@ Handles the change event. #### Defined in -[packages/form-core/src/FieldApi.ts:949](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L949) +[packages/form-core/src/FieldApi.ts:949](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L949) *** @@ -242,7 +242,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri #### Defined in -[packages/form-core/src/FieldApi.ts:655](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L655) +[packages/form-core/src/FieldApi.ts:655](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L655) *** @@ -264,7 +264,7 @@ Mounts the field instance to the form. #### Defined in -[packages/form-core/src/FieldApi.ts:517](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L517) +[packages/form-core/src/FieldApi.ts:517](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L517) *** @@ -293,7 +293,7 @@ Moves the value at the first specified index to the second specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:685](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L685) +[packages/form-core/src/FieldApi.ts:685](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L685) *** @@ -317,7 +317,7 @@ Pushes a new value to the field. #### Defined in -[packages/form-core/src/FieldApi.ts:647](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L647) +[packages/form-core/src/FieldApi.ts:647](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L647) *** @@ -341,7 +341,7 @@ Removes a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:673](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L673) +[packages/form-core/src/FieldApi.ts:673](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L673) *** @@ -370,7 +370,7 @@ Replaces a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:664](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L664) +[packages/form-core/src/FieldApi.ts:664](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L664) *** @@ -384,7 +384,7 @@ Sets the field metadata. #### Parameters -• **updater**: [`Updater`](Updater.md)\<[`FieldMeta`](FieldMeta.md)\> +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\> #### Returns @@ -392,7 +392,7 @@ Sets the field metadata. #### Defined in -[packages/form-core/src/FieldApi.ts:636](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L636) +[packages/form-core/src/FieldApi.ts:636](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L636) *** @@ -406,7 +406,7 @@ Sets the field value and run the `change` validator. #### Parameters -• **updater**: [`Updater`](Updater.md)\<`TData`\> +• **updater**: [`Updater`](../type-aliases/updater.md)\<`TData`\> • **options?**: `UpdateMetaOptions` @@ -416,7 +416,7 @@ Sets the field value and run the `change` validator. #### Defined in -[packages/form-core/src/FieldApi.ts:608](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L608) +[packages/form-core/src/FieldApi.ts:608](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L608) *** @@ -445,7 +445,7 @@ Swaps the values at the specified indices. #### Defined in -[packages/form-core/src/FieldApi.ts:679](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L679) +[packages/form-core/src/FieldApi.ts:679](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L679) *** @@ -459,7 +459,7 @@ Updates the field instance with new options. #### Parameters -• **opts**: [`FieldApiOptions`](FieldApiOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +• **opts**: [`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Returns @@ -467,7 +467,7 @@ Updates the field instance with new options. #### Defined in -[packages/form-core/src/FieldApi.ts:564](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L564) +[packages/form-core/src/FieldApi.ts:564](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L564) *** @@ -485,8 +485,8 @@ Validates the field value. #### Returns -[`ValidationError`](ValidationError.md)[] \| `Promise`\<[`ValidationError`](ValidationError.md)[]\> +[`ValidationError`](../type-aliases/validationerror.md)[] \| `Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> #### Defined in -[packages/form-core/src/FieldApi.ts:923](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L923) +[packages/form-core/src/FieldApi.ts:923](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L923) diff --git a/docs/reference/FormApi.md b/docs/reference/classes/formapi.md similarity index 75% rename from docs/reference/FormApi.md rename to docs/reference/classes/formapi.md index 9d938539e..81532d968 100644 --- a/docs/reference/FormApi.md +++ b/docs/reference/classes/formapi.md @@ -29,15 +29,15 @@ Constructs a new `FormApi` instance with the given form options. #### Parameters -• **opts?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> +• **opts?**: [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> #### Returns -[`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> +[`FormApi`](formapi.md)\<`TFormData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FormApi.ts:345](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L345) +[packages/form-core/src/FormApi.ts:345](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L345) ## Properties @@ -51,7 +51,7 @@ A record of field information for each field in the form. #### Defined in -[packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L334) +[packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L334) *** @@ -65,7 +65,7 @@ The options for the form. #### Defined in -[packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L318) +[packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L318) *** @@ -83,7 +83,7 @@ Please use form.useStore() utility to subscribe to state #### Defined in -[packages/form-core/src/FormApi.ts:330](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L330) +[packages/form-core/src/FormApi.ts:330](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L330) *** @@ -97,7 +97,7 @@ A [TanStack Store instance](https://tanstack.com/store/latest/docs/reference/Sto #### Defined in -[packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L322) +[packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L322) ## Methods @@ -121,7 +121,7 @@ deleteField(field): void #### Defined in -[packages/form-core/src/FormApi.ts:925](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L925) +[packages/form-core/src/FormApi.ts:925](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L925) *** @@ -143,11 +143,11 @@ Gets the field info of the specified field. #### Returns -[`FieldInfo`](FieldInfo.md)\<`TFormData`, `TFormValidator`\> +[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TFormData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FormApi.ts:843](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L843) +[packages/form-core/src/FormApi.ts:843](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L843) *** @@ -169,11 +169,11 @@ Gets the metadata of the specified field. #### Returns -`undefined` \| [`FieldMeta`](FieldMeta.md) +`undefined` \| [`FieldMeta`](../type-aliases/fieldmeta.md) #### Defined in -[packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L834) +[packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L834) *** @@ -195,11 +195,11 @@ Gets the value of the specified field. #### Returns -[`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> +[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> #### Defined in -[packages/form-core/src/FormApi.ts:827](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L827) +[packages/form-core/src/FormApi.ts:827](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L827) *** @@ -217,7 +217,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu #### Defined in -[packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L767) +[packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L767) *** @@ -243,7 +243,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ • **index**: `number` -• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -253,7 +253,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ #### Defined in -[packages/form-core/src/FormApi.ts:957](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L957) +[packages/form-core/src/FormApi.ts:957](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L957) *** @@ -269,7 +269,7 @@ mount(): void #### Defined in -[packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L443) +[packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L443) *** @@ -305,7 +305,7 @@ Moves the value at the first specified index to the second specified index withi #### Defined in -[packages/form-core/src/FormApi.ts:1075](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1075) +[packages/form-core/src/FormApi.ts:1075](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1075) *** @@ -328,7 +328,7 @@ Pushes a value into an array field. • **field**: `TField` -• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -338,7 +338,7 @@ Pushes a value into an array field. #### Defined in -[packages/form-core/src/FormApi.ts:939](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L939) +[packages/form-core/src/FormApi.ts:939](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L939) *** @@ -371,7 +371,7 @@ Removes a value from an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:1010](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1010) +[packages/form-core/src/FormApi.ts:1010](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1010) *** @@ -397,7 +397,7 @@ Replaces a value into an array field at the specified index. • **index**: `number` -• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -407,7 +407,7 @@ Replaces a value into an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L984) +[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L984) *** @@ -425,7 +425,7 @@ Resets the form state to the default values. #### Defined in -[packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L505) +[packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L505) *** @@ -441,15 +441,15 @@ resetFieldMeta(fieldMeta): Record #### Parameters -• **fieldMeta**: `Record`\<`TField`, [`FieldMeta`](FieldMeta.md)\> +• **fieldMeta**: `Record`\<`TField`, [`FieldMeta`](../type-aliases/fieldmeta.md)\> #### Returns -`Record`\<`TField`, [`FieldMeta`](FieldMeta.md)\> +`Record`\<`TField`, [`FieldMeta`](../type-aliases/fieldmeta.md)\> #### Defined in -[packages/form-core/src/FormApi.ts:877](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L877) +[packages/form-core/src/FormApi.ts:877](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L877) *** @@ -469,7 +469,7 @@ Updates the metadata of the specified field. • **field**: `TField` -• **updater**: [`Updater`](Updater.md)\<[`FieldMeta`](FieldMeta.md)\> +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\> #### Returns @@ -477,7 +477,7 @@ Updates the metadata of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:862](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L862) +[packages/form-core/src/FormApi.ts:862](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L862) *** @@ -500,7 +500,7 @@ Sets the value of the specified field and optionally updates the touched state. • **field**: `TField` -• **updater**: [`Updater`](Updater.md)\<[`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\> +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\> • **opts?**: `UpdateMetaOptions` @@ -510,7 +510,7 @@ Sets the value of the specified field and optionally updates the touched state. #### Defined in -[packages/form-core/src/FormApi.ts:900](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L900) +[packages/form-core/src/FormApi.ts:900](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L900) *** @@ -546,7 +546,7 @@ Swaps the values at the specified indices within an array field. #### Defined in -[packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1049) +[packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1049) *** @@ -560,7 +560,7 @@ Updates the form options and form state. #### Parameters -• **options?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> +• **options?**: [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> #### Returns @@ -568,7 +568,7 @@ Updates the form options and form state. #### Defined in -[packages/form-core/src/FormApi.ts:465](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L465) +[packages/form-core/src/FormApi.ts:465](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L465) *** @@ -586,11 +586,11 @@ Validates all fields in the form using the correct handlers for a given validati #### Returns -`Promise`\<[`ValidationError`](ValidationError.md)[]\> +`Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L520) +[packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L520) *** @@ -619,11 +619,11 @@ Validates the children of a specified array in the form starting from a given in #### Returns -`Promise`\<[`ValidationError`](ValidationError.md)[]\> +`Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:547](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L547) +[packages/form-core/src/FormApi.ts:547](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L547) *** @@ -647,8 +647,8 @@ Validates a specified field in the form using the correct handlers for a given v #### Returns -[`ValidationError`](ValidationError.md)[] \| `Promise`\<[`ValidationError`](ValidationError.md)[]\> +[`ValidationError`](../type-aliases/validationerror.md)[] \| `Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:586](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L586) +[packages/form-core/src/FormApi.ts:586](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L586) diff --git a/docs/reference/formOptions.md b/docs/reference/functions/formoptions.md similarity index 64% rename from docs/reference/formOptions.md rename to docs/reference/functions/formoptions.md index c9c1ad01c..124dbee00 100644 --- a/docs/reference/formOptions.md +++ b/docs/reference/functions/formoptions.md @@ -17,12 +17,12 @@ function formOptions(defaultOpts?): undefined | FormO ## Parameters -• **defaultOpts?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> +• **defaultOpts?**: [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> ## Returns -`undefined` \| [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> +`undefined` \| [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> ## Defined in -[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/formOptions.ts#L4) +[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/formOptions.ts#L4) diff --git a/docs/reference/mergeForm.md b/docs/reference/functions/mergeform.md similarity index 57% rename from docs/reference/mergeForm.md rename to docs/reference/functions/mergeform.md index 28258e9a1..3bc4ae86c 100644 --- a/docs/reference/mergeForm.md +++ b/docs/reference/functions/mergeform.md @@ -17,14 +17,14 @@ function mergeForm(baseForm, state): FormApi, `NoInfer`\<`TFormValidator`\>\> +• **baseForm**: [`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> -• **state**: `Partial`\<[`FormState`](FormState.md)\<`TFormData`\>\> +• **state**: `Partial`\<[`FormState`](../type-aliases/formstate.md)\<`TFormData`\>\> ## Returns -[`FormApi`](FormApi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> +[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> ## Defined in -[packages/form-core/src/mergeForm.ts:37](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/mergeForm.ts#L37) +[packages/form-core/src/mergeForm.ts:37](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/mergeForm.ts#L37) diff --git a/docs/reference/index.md b/docs/reference/index.md index c14fc1f05..fc7b212d2 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -7,31 +7,31 @@ title: "@tanstack/form-core" ## Classes -- [FieldApi](FieldApi.md) -- [FormApi](FormApi.md) +- [FieldApi](classes/fieldapi.md) +- [FormApi](classes/formapi.md) ## Interfaces -- [FieldApiOptions](FieldApiOptions.md) -- [FieldOptions](FieldOptions.md) -- [FieldValidators](FieldValidators.md) -- [FormOptions](FormOptions.md) -- [FormValidators](FormValidators.md) +- [FieldApiOptions](interfaces/fieldapioptions.md) +- [FieldOptions](interfaces/fieldoptions.md) +- [FieldValidators](interfaces/fieldvalidators.md) +- [FormOptions](interfaces/formoptions.md) +- [FormValidators](interfaces/formvalidators.md) ## Type Aliases -- [DeepKeys](DeepKeys.md) -- [DeepValue](DeepValue.md) -- [FieldInfo](FieldInfo.md) -- [FieldMeta](FieldMeta.md) -- [FieldState](FieldState.md) -- [FormState](FormState.md) -- [Updater](Updater.md) -- [UpdaterFn](UpdaterFn.md) -- [ValidationError](ValidationError.md) -- [ValidationMeta](ValidationMeta.md) +- [DeepKeys](type-aliases/deepkeys.md) +- [DeepValue](type-aliases/deepvalue.md) +- [FieldInfo](type-aliases/fieldinfo.md) +- [FieldMeta](type-aliases/fieldmeta.md) +- [FieldState](type-aliases/fieldstate.md) +- [FormState](type-aliases/formstate.md) +- [Updater](type-aliases/updater.md) +- [UpdaterFn](type-aliases/updaterfn.md) +- [ValidationError](type-aliases/validationerror.md) +- [ValidationMeta](type-aliases/validationmeta.md) ## Functions -- [formOptions](formOptions.md) -- [mergeForm](mergeForm.md) +- [formOptions](functions/formoptions.md) +- [mergeForm](functions/mergeform.md) diff --git a/docs/reference/FieldApiOptions.md b/docs/reference/interfaces/fieldapioptions.md similarity index 63% rename from docs/reference/FieldApiOptions.md rename to docs/reference/interfaces/fieldapioptions.md index 27400204e..d20afe187 100644 --- a/docs/reference/FieldApiOptions.md +++ b/docs/reference/interfaces/fieldapioptions.md @@ -9,19 +9,19 @@ An object type representing the required options for the FieldApi class. ## Extends -- [`FieldOptions`](FieldOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +- [`FieldOptions`](fieldoptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> ## Type Parameters • **TParentData** -• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> ## Properties @@ -35,11 +35,11 @@ If `true`, always run async validation, even if there are errors emitted during #### Inherited from -[`FieldOptions`](FieldOptions.md).[`asyncAlways`](Interface.FieldOptions.md#asyncalways) +[`FieldOptions`](fieldoptions.md).[`asyncAlways`](FieldOptions.md#asyncalways) #### Defined in -[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L284) +[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L284) *** @@ -53,11 +53,11 @@ The default time to debounce async validation if there is not a more specific de #### Inherited from -[`FieldOptions`](FieldOptions.md).[`asyncDebounceMs`](Interface.FieldOptions.md#asyncdebouncems) +[`FieldOptions`](fieldoptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems) #### Defined in -[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L280) +[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L280) *** @@ -71,11 +71,11 @@ An optional object with default metadata for the field. #### Inherited from -[`FieldOptions`](FieldOptions.md).[`defaultMeta`](Interface.FieldOptions.md#defaultmeta) +[`FieldOptions`](fieldoptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta) #### Defined in -[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L302) +[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L302) *** @@ -89,11 +89,11 @@ An optional default value for the field. #### Inherited from -[`FieldOptions`](FieldOptions.md).[`defaultValue`](Interface.FieldOptions.md#defaultvalue) +[`FieldOptions`](fieldoptions.md).[`defaultValue`](FieldOptions.md#defaultvalue) #### Defined in -[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L276) +[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L276) *** @@ -105,7 +105,7 @@ form: FormApi; #### Defined in -[packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L325) +[packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L325) *** @@ -119,11 +119,11 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Inherited from -[`FieldOptions`](FieldOptions.md).[`name`](Interface.FieldOptions.md#name) +[`FieldOptions`](fieldoptions.md).[`name`](FieldOptions.md#name) #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L272) *** @@ -137,11 +137,11 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Inherited from -[`FieldOptions`](FieldOptions.md).[`validatorAdapter`](Interface.FieldOptions.md#validatoradapter) +[`FieldOptions`](fieldoptions.md).[`validatorAdapter`](FieldOptions.md#validatoradapter) #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L288) *** @@ -155,8 +155,8 @@ A list of validators to pass to the field #### Inherited from -[`FieldOptions`](FieldOptions.md).[`validators`](Interface.FieldOptions.md#validators) +[`FieldOptions`](fieldoptions.md).[`validators`](FieldOptions.md#validators) #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L292) diff --git a/docs/reference/FieldOptions.md b/docs/reference/interfaces/fieldoptions.md similarity index 71% rename from docs/reference/FieldOptions.md rename to docs/reference/interfaces/fieldoptions.md index 9e02fdb30..ad3fe3916 100644 --- a/docs/reference/FieldOptions.md +++ b/docs/reference/interfaces/fieldoptions.md @@ -9,19 +9,19 @@ An object type representing the options for a field in a form. ## Extended by -- [`FieldApiOptions`](FieldApiOptions.md) +- [`FieldApiOptions`](fieldapioptions.md) ## Type Parameters • **TParentData** -• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> ## Properties @@ -35,7 +35,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L284) +[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L284) *** @@ -49,7 +49,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L280) +[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L280) *** @@ -63,7 +63,7 @@ An optional object with default metadata for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L302) +[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L302) *** @@ -77,7 +77,7 @@ An optional default value for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L276) +[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L276) *** @@ -91,7 +91,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L272) *** @@ -105,7 +105,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L288) *** @@ -119,4 +119,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L292) diff --git a/docs/reference/FieldValidators.md b/docs/reference/interfaces/fieldvalidators.md similarity index 84% rename from docs/reference/FieldValidators.md rename to docs/reference/interfaces/fieldvalidators.md index 6907606ed..7e6188403 100644 --- a/docs/reference/FieldValidators.md +++ b/docs/reference/interfaces/fieldvalidators.md @@ -9,13 +9,13 @@ title: FieldValidators • **TParentData** -• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> ## Properties @@ -36,7 +36,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:196](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L196) +[packages/form-core/src/FieldApi.ts:196](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L196) *** @@ -57,7 +57,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:209](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L209) +[packages/form-core/src/FieldApi.ts:209](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L209) *** @@ -73,7 +73,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:222](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L222) +[packages/form-core/src/FieldApi.ts:222](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L222) *** @@ -87,7 +87,7 @@ An optional list of field names that should trigger this field's `onBlur` and `o #### Defined in -[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L226) +[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L226) *** @@ -108,7 +108,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:160](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L160) +[packages/form-core/src/FieldApi.ts:160](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L160) *** @@ -129,7 +129,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:173](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L173) +[packages/form-core/src/FieldApi.ts:173](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L173) *** @@ -145,7 +145,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L185) +[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L185) *** @@ -159,7 +159,7 @@ An optional list of field names that should trigger this field's `onChange` and #### Defined in -[packages/form-core/src/FieldApi.ts:189](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L189) +[packages/form-core/src/FieldApi.ts:189](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L189) *** @@ -173,7 +173,7 @@ An optional function that takes a param of `formApi` which is a generic type of #### Defined in -[packages/form-core/src/FieldApi.ts:147](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L147) +[packages/form-core/src/FieldApi.ts:147](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L147) *** @@ -194,7 +194,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:233](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L233) +[packages/form-core/src/FieldApi.ts:233](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L233) *** @@ -215,4 +215,4 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:246](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L246) +[packages/form-core/src/FieldApi.ts:246](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L246) diff --git a/docs/reference/FormOptions.md b/docs/reference/interfaces/formoptions.md similarity index 79% rename from docs/reference/FormOptions.md rename to docs/reference/interfaces/formoptions.md index 65b3593dc..acdb97717 100644 --- a/docs/reference/FormOptions.md +++ b/docs/reference/interfaces/formoptions.md @@ -25,7 +25,7 @@ If true, always run async validation, even when sync validation has produced an #### Defined in -[packages/form-core/src/FormApi.ts:133](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L133) +[packages/form-core/src/FormApi.ts:133](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L133) *** @@ -39,7 +39,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off #### Defined in -[packages/form-core/src/FormApi.ts:137](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L137) +[packages/form-core/src/FormApi.ts:137](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L137) *** @@ -53,7 +53,7 @@ The default state for the form. #### Defined in -[packages/form-core/src/FormApi.ts:129](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L129) +[packages/form-core/src/FormApi.ts:129](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L129) *** @@ -67,7 +67,7 @@ Set initial values for your form. #### Defined in -[packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L125) +[packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L125) *** @@ -83,7 +83,7 @@ A function to be called when the form is submitted, what should happen once the • **props** -• **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> +• **props.formApi**: [`FormApi`](../classes/formapi.md)\<`TFormData`, `TFormValidator`\> • **props.value**: `TFormData` @@ -93,7 +93,7 @@ A function to be called when the form is submitted, what should happen once the #### Defined in -[packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L149) +[packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L149) *** @@ -109,7 +109,7 @@ Specify an action for scenarios where the user tries to submit an invalid form. • **props** -• **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> +• **props.formApi**: [`FormApi`](../classes/formapi.md)\<`TFormData`, `TFormValidator`\> • **props.value**: `TFormData` @@ -119,7 +119,7 @@ Specify an action for scenarios where the user tries to submit an invalid form. #### Defined in -[packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L156) +[packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L156) *** @@ -131,7 +131,7 @@ optional transform: FormTransform; #### Defined in -[packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L160) +[packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L160) *** @@ -145,7 +145,7 @@ A validator adapter to support usage of extra validation types (IE: Zod, Yup, or #### Defined in -[packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L141) +[packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L141) *** @@ -159,4 +159,4 @@ A list of validators to pass to the form #### Defined in -[packages/form-core/src/FormApi.ts:145](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L145) +[packages/form-core/src/FormApi.ts:145](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L145) diff --git a/docs/reference/FormValidators.md b/docs/reference/interfaces/formvalidators.md similarity index 83% rename from docs/reference/FormValidators.md rename to docs/reference/interfaces/formvalidators.md index 55fa9bd7b..fdda37c59 100644 --- a/docs/reference/FormValidators.md +++ b/docs/reference/interfaces/formvalidators.md @@ -23,7 +23,7 @@ Optional function that validates the form data when a field loses focus, returns #### Defined in -[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L89) +[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L89) *** @@ -37,7 +37,7 @@ Optional onBlur asynchronous validation method for when a field loses focus retu #### Defined in -[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L93) +[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L93) *** @@ -51,7 +51,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L97) +[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L97) *** @@ -65,7 +65,7 @@ Optional function that checks the validity of your data whenever a value changes #### Defined in -[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L77) +[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L77) *** @@ -79,7 +79,7 @@ Optional onChange asynchronous counterpart to onChange. Useful for more complex #### Defined in -[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L81) +[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L81) *** @@ -93,7 +93,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L85) +[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L85) *** @@ -107,7 +107,7 @@ Optional function that fires as soon as the component mounts. #### Defined in -[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L73) +[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L73) *** @@ -119,7 +119,7 @@ optional onSubmit: FormValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L98) +[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L98) *** @@ -131,4 +131,4 @@ optional onSubmitAsync: FormAsyncValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L99) +[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L99) diff --git a/docs/reference/DeepKeys.md b/docs/reference/type-aliases/deepkeys.md similarity index 91% rename from docs/reference/DeepKeys.md rename to docs/reference/type-aliases/deepkeys.md index 1122b8811..dad50d909 100644 --- a/docs/reference/DeepKeys.md +++ b/docs/reference/type-aliases/deepkeys.md @@ -19,4 +19,4 @@ The keys of an object or array, deeply nested. ## Defined in -[packages/form-core/src/util-types.ts:85](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/util-types.ts#L85) +[packages/form-core/src/util-types.ts:85](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/util-types.ts#L85) diff --git a/docs/reference/DeepValue.md b/docs/reference/type-aliases/deepvalue.md similarity index 95% rename from docs/reference/DeepValue.md rename to docs/reference/type-aliases/deepvalue.md index e072c7325..b45a42306 100644 --- a/docs/reference/DeepValue.md +++ b/docs/reference/type-aliases/deepvalue.md @@ -21,4 +21,4 @@ Infer the type of a deeply nested property within an object or an array. ## Defined in -[packages/form-core/src/util-types.ts:109](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/util-types.ts#L109) +[packages/form-core/src/util-types.ts:109](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/util-types.ts#L109) diff --git a/docs/reference/FieldInfo.md b/docs/reference/type-aliases/fieldinfo.md similarity index 92% rename from docs/reference/FieldInfo.md rename to docs/reference/type-aliases/fieldinfo.md index 8ea7bfe45..91c04fac2 100644 --- a/docs/reference/FieldInfo.md +++ b/docs/reference/type-aliases/fieldinfo.md @@ -37,4 +37,4 @@ A record of field validation internal handling. ## Defined in -[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L176) +[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L176) diff --git a/docs/reference/FieldMeta.md b/docs/reference/type-aliases/fieldmeta.md similarity index 94% rename from docs/reference/FieldMeta.md rename to docs/reference/type-aliases/fieldmeta.md index 4bc3dc341..47498dd7a 100644 --- a/docs/reference/FieldMeta.md +++ b/docs/reference/type-aliases/fieldmeta.md @@ -63,4 +63,4 @@ A flag indicating whether the field is currently being validated. ## Defined in -[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L331) +[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L331) diff --git a/docs/reference/FieldState.md b/docs/reference/type-aliases/fieldstate.md similarity index 88% rename from docs/reference/FieldState.md rename to docs/reference/type-aliases/fieldstate.md index 3bee65106..0a013c9ef 100644 --- a/docs/reference/FieldState.md +++ b/docs/reference/type-aliases/fieldstate.md @@ -35,4 +35,4 @@ The current value of the field. ## Defined in -[packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L361) +[packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L361) diff --git a/docs/reference/FormState.md b/docs/reference/type-aliases/formstate.md similarity index 97% rename from docs/reference/FormState.md rename to docs/reference/type-aliases/formstate.md index 94b296103..d1407bc95 100644 --- a/docs/reference/FormState.md +++ b/docs/reference/type-aliases/formstate.md @@ -163,4 +163,4 @@ The current values of the form fields. ## Defined in -[packages/form-core/src/FormApi.ts:198](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L198) +[packages/form-core/src/FormApi.ts:198](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L198) diff --git a/docs/reference/Updater.md b/docs/reference/type-aliases/updater.md similarity index 83% rename from docs/reference/Updater.md rename to docs/reference/type-aliases/updater.md index dd8e6f586..0e7a1211d 100644 --- a/docs/reference/Updater.md +++ b/docs/reference/type-aliases/updater.md @@ -17,4 +17,4 @@ type Updater: TOutput | UpdaterFn; ## Defined in -[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/utils.ts#L7) +[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/utils.ts#L7) diff --git a/docs/reference/UpdaterFn.md b/docs/reference/type-aliases/updaterfn.md similarity index 85% rename from docs/reference/UpdaterFn.md rename to docs/reference/type-aliases/updaterfn.md index 5c8f1daf6..1444edf8b 100644 --- a/docs/reference/UpdaterFn.md +++ b/docs/reference/type-aliases/updaterfn.md @@ -25,4 +25,4 @@ type UpdaterFn: (input) => TOutput; ## Defined in -[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/utils.ts#L5) +[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/utils.ts#L5) diff --git a/docs/reference/ValidationError.md b/docs/reference/type-aliases/validationerror.md similarity index 79% rename from docs/reference/ValidationError.md rename to docs/reference/type-aliases/validationerror.md index bf3395870..9688add73 100644 --- a/docs/reference/ValidationError.md +++ b/docs/reference/type-aliases/validationerror.md @@ -11,4 +11,4 @@ type ValidationError: undefined | false | null | string; ## Defined in -[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/types.ts#L1) +[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/types.ts#L1) diff --git a/docs/reference/ValidationMeta.md b/docs/reference/type-aliases/validationmeta.md similarity index 88% rename from docs/reference/ValidationMeta.md rename to docs/reference/type-aliases/validationmeta.md index aaae801cb..77eb94590 100644 --- a/docs/reference/ValidationMeta.md +++ b/docs/reference/type-aliases/validationmeta.md @@ -23,4 +23,4 @@ An abort controller stored in memory to cancel previous async validation attempt ## Defined in -[packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L166) +[packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L166) diff --git a/eslint.config.js b/eslint.config.js index 98f63cae2..18c265e9d 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -8,13 +8,13 @@ export default [ { name: 'tanstack/temp', rules: { - 'ts/array-type': 'off', - 'ts/ban-types': 'off', - 'ts/method-signature-style': 'off', - 'ts/naming-convention': 'off', - 'ts/no-unnecessary-type-assertion': 'off', + '@typescript-eslint/array-type': 'off', + '@typescript-eslint/ban-types': 'off', + '@typescript-eslint/method-signature-style': 'off', + '@typescript-eslint/naming-convention': 'off', + '@typescript-eslint/no-unnecessary-type-assertion': 'off', + '@typescript-eslint/require-await': 'off', 'no-async-promise-executor': 'off', - 'ts/require-await': 'off', 'no-empty': 'off', }, }, diff --git a/package.json b/package.json index 04b9d8700..a390e4e90 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "devDependencies": { "@eslint-react/eslint-plugin": "^1.5.26", "@solidjs/testing-library": "^0.8.8", - "@tanstack/config": "^0.10.0", + "@tanstack/config": "^0.11.1", "@testing-library/jest-dom": "^6.4.6", "@testing-library/react": "^16.0.0", "@testing-library/user-event": "^14.5.2", diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index eaf54e228..363d118c4 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -547,7 +547,7 @@ export class FieldApi< if (error) { this.setMeta((prev) => ({ ...prev, - // eslint-disable-next-line ts/no-unnecessary-condition + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition errorMap: { ...prev?.errorMap, onMount: error }, })) } @@ -876,7 +876,7 @@ export class FieldApi< return { ...prev, errorMap: { - // eslint-disable-next-line ts/no-unnecessary-condition + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition ...prev?.errorMap, [getErrorMapKey(cause)]: error, }, diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index b47242060..4b8496073 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -587,7 +587,7 @@ export class FormApi< field: TField, cause: ValidationCause, ) => { - // eslint-disable-next-line ts/no-unnecessary-condition + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition const fieldInstance = this.fieldInfo[field]?.instance if (!fieldInstance) return [] @@ -843,7 +843,7 @@ export class FormApi< getFieldInfo = >( field: TField, ): FieldInfo => { - // eslint-disable-next-line ts/no-unnecessary-condition + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition return (this.fieldInfo[field] ||= { instance: null, validationMetaMap: { diff --git a/packages/form-core/src/mergeForm.ts b/packages/form-core/src/mergeForm.ts index 2a184f114..202e307af 100644 --- a/packages/form-core/src/mergeForm.ts +++ b/packages/form-core/src/mergeForm.ts @@ -24,7 +24,7 @@ export function mutateMergeDeep(target: object, source: object): object { mutateMergeDeep(target[targetKey] as {}, source[sourceKey] as {}) } else { // Prevent assigning undefined to target, only if undefined is not explicitly set on source - // eslint-disable-next-line ts/no-unnecessary-condition + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition if (!(sourceKey in source) && source[sourceKey] === undefined) { continue } diff --git a/packages/react-form/tests/useField.test.tsx b/packages/react-form/tests/useField.test.tsx index f4542730b..7bdb6751d 100644 --- a/packages/react-form/tests/useField.test.tsx +++ b/packages/react-form/tests/useField.test.tsx @@ -426,7 +426,7 @@ describe('useField', () => { firstName: '', lastName: '', }, - // eslint-disable-next-line ts/no-empty-function + // eslint-disable-next-line @typescript-eslint/no-empty-function onSubmit: async () => {}, }) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e3445fdcd..87a27c429 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -15,8 +15,8 @@ importers: specifier: ^0.8.8 version: 0.8.8(@solidjs/router@0.13.0(solid-js@1.8.18))(solid-js@1.8.18) '@tanstack/config': - specifier: ^0.10.0 - version: 0.10.0(@types/node@20.14.10)(esbuild@0.21.5)(eslint@8.57.0)(rollup@4.18.0)(typescript@5.4.2)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1)) + specifier: ^0.11.1 + version: 0.11.1(@types/node@20.14.10)(esbuild@0.21.5)(eslint@8.57.0)(rollup@4.18.0)(typescript@5.4.2)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1)) '@testing-library/jest-dom': specifier: ^6.4.6 version: 6.4.6(vitest@1.6.0(@types/node@20.14.10)(jsdom@24.1.0)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1)) @@ -3674,6 +3674,12 @@ packages: '@solidjs/router': optional: true + '@stylistic/eslint-plugin-js@2.3.0': + resolution: {integrity: sha512-lQwoiYb0Fs6Yc5QS3uT8+T9CPKK2Eoxc3H8EnYJgM26v/DgtW+1lvy2WNgyBflU+ThShZaHm3a6CdD9QeKx23w==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: '>=8.40.0' + '@swc/core-darwin-arm64@1.6.13': resolution: {integrity: sha512-SOF4buAis72K22BGJ3N8y88mLNfxLNprTuJUpzikyMGrvkuBFNcxYtMhmomO0XHsgLDzOJ+hWzcgjRNzjMsUcQ==} engines: {node: '>=10'} @@ -3758,8 +3764,8 @@ packages: '@angular/common': '>=16 < 18' '@angular/core': '>=16 < 18' - '@tanstack/config@0.10.0': - resolution: {integrity: sha512-Yz+7cWxuDo8onU2nm4+kwA9B2GSp+l1k8oSrqiERNkmRu6dKtiiW8ENFqLuXi0p5fi0sBdLeUcEhfMxTifzmtA==} + '@tanstack/config@0.11.1': + resolution: {integrity: sha512-P/U2ANQZMGpd6uBiVarY+SEVzCM50BOBV+C9c2pUZbMm3gtZN0a2LzX0fT0DutkeX3TsR5ogCw0ohxGzE4GcWw==} engines: {node: '>=18'} hasBin: true @@ -4073,12 +4079,12 @@ packages: typescript: optional: true - '@typescript-eslint/eslint-plugin@7.16.1': - resolution: {integrity: sha512-SxdPak/5bO0EnGktV05+Hq8oatjAYVY3Zh2bye9pGZy6+jwyR3LG3YKkV4YatlsgqXP28BTeVm9pqwJM96vf2A==} + '@typescript-eslint/eslint-plugin@7.17.0': + resolution: {integrity: sha512-pyiDhEuLM3PuANxH7uNYan1AaFs5XE0zw1hq69JBvGvE7gSuEoQl1ydtEe/XQeoC3GQxLXyOVa5kNOATgM638A==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: '@typescript-eslint/parser': ^7.0.0 - eslint: ^8.56.0 + eslint: ^8.57.0 typescript: '*' peerDependenciesMeta: typescript: @@ -4094,11 +4100,11 @@ packages: typescript: optional: true - '@typescript-eslint/parser@7.16.1': - resolution: {integrity: sha512-u+1Qx86jfGQ5i4JjK33/FnawZRpsLxRnKzGE6EABZ40KxVT/vWsiZFEBBHjFOljmmV3MBYOHEKi0Jm9hbAOClA==} + '@typescript-eslint/parser@7.17.0': + resolution: {integrity: sha512-puiYfGeg5Ydop8eusb/Hy1k7QmOU6X3nvsqCgzrB2K4qMavK//21+PzNE8qeECgNOIoertJPUC1SpegHDI515A==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: - eslint: ^8.57.0 + eslint: ^8.56.0 typescript: '*' peerDependenciesMeta: typescript: @@ -4108,8 +4114,8 @@ packages: resolution: {integrity: sha512-8gVv3kW6n01Q6TrI1cmTZ9YMFi3ucDT7i7aI5lEikk2ebk1AEjrwX8MDTdaX5D7fPXMBLvnsaa0IFTAu+jcfOw==} engines: {node: ^18.18.0 || >=20.0.0} - '@typescript-eslint/scope-manager@7.16.1': - resolution: {integrity: sha512-nYpyv6ALte18gbMz323RM+vpFpTjfNdyakbf3nsLvF43uF9KeNC289SUEW3QLZ1xPtyINJ1dIsZOuWuSRIWygw==} + '@typescript-eslint/scope-manager@7.17.0': + resolution: {integrity: sha512-0P2jTTqyxWp9HiKLu/Vemr2Rg1Xb5B7uHItdVZ6iAenXmPo4SZ86yOPCJwMqpCyaMiEHTNqizHfsbmCFT1x9SA==} engines: {node: ^18.18.0 || >=20.0.0} '@typescript-eslint/type-utils@7.16.0': @@ -4122,8 +4128,8 @@ packages: typescript: optional: true - '@typescript-eslint/type-utils@7.16.1': - resolution: {integrity: sha512-rbu/H2MWXN4SkjIIyWcmYBjlp55VT+1G3duFOIukTNFxr9PI35pLc2ydwAfejCEitCv4uztA07q0QWanOHC7dA==} + '@typescript-eslint/type-utils@7.17.0': + resolution: {integrity: sha512-XD3aaBt+orgkM/7Cei0XNEm1vwUxQ958AOLALzPlbPqb8C1G8PZK85tND7Jpe69Wualri81PLU+Zc48GVKIMMA==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.56.0 @@ -4136,8 +4142,8 @@ packages: resolution: {integrity: sha512-fecuH15Y+TzlUutvUl9Cc2XJxqdLr7+93SQIbcZfd4XRGGKoxyljK27b+kxKamjRkU7FYC6RrbSCg0ALcZn/xw==} engines: {node: ^18.18.0 || >=20.0.0} - '@typescript-eslint/types@7.16.1': - resolution: {integrity: sha512-AQn9XqCzUXd4bAVEsAXM/Izk11Wx2u4H3BAfQVhSfzfDOm/wAON9nP7J5rpkCxts7E5TELmN845xTUCQrD1xIQ==} + '@typescript-eslint/types@7.17.0': + resolution: {integrity: sha512-a29Ir0EbyKTKHnZWbNsrc/gqfIBqYPwj3F2M+jWE/9bqfEHg0AMtXzkbUkOG6QgEScxh2+Pz9OXe11jHDnHR7A==} engines: {node: ^18.18.0 || >=20.0.0} '@typescript-eslint/typescript-estree@7.16.0': @@ -4149,8 +4155,8 @@ packages: typescript: optional: true - '@typescript-eslint/typescript-estree@7.16.1': - resolution: {integrity: sha512-0vFPk8tMjj6apaAZ1HlwM8w7jbghC8jc1aRNJG5vN8Ym5miyhTQGMqU++kuBFDNKe9NcPeZ6x0zfSzV8xC1UlQ==} + '@typescript-eslint/typescript-estree@7.17.0': + resolution: {integrity: sha512-72I3TGq93t2GoSBWI093wmKo0n6/b7O4j9o8U+f65TVD0FS6bI2180X5eGEr8MA8PhKMvYe9myZJquUT2JkCZw==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: typescript: '*' @@ -4164,8 +4170,8 @@ packages: peerDependencies: eslint: ^8.56.0 - '@typescript-eslint/utils@7.16.1': - resolution: {integrity: sha512-WrFM8nzCowV0he0RlkotGDujx78xudsxnGMBHI88l5J8wEhED6yBwaSLP99ygfrzAjsQvcYQ94quDwI0d7E1fA==} + '@typescript-eslint/utils@7.17.0': + resolution: {integrity: sha512-r+JFlm5NdB+JXc7aWWZ3fKSm1gn0pkswEwIYsrGPdsT2GjsRATAKXiNtp3vgAAO1xZhX8alIOEQnNMl3kbTgJw==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.56.0 @@ -4174,8 +4180,8 @@ packages: resolution: {integrity: sha512-rMo01uPy9C7XxG7AFsxa8zLnWXTF8N3PYclekWSrurvhwiw1eW88mrKiAYe6s53AUY57nTRz8dJsuuXdkAhzCg==} engines: {node: ^18.18.0 || >=20.0.0} - '@typescript-eslint/visitor-keys@7.16.1': - resolution: {integrity: sha512-Qlzzx4sE4u3FsHTPQAAQFJFNOuqtuY0LFrZHwQ8IHK705XxBiWOFkfKRWu6niB7hwfgnwIpO4jTC75ozW1PHWg==} + '@typescript-eslint/visitor-keys@7.17.0': + resolution: {integrity: sha512-RVGC9UhPOCsfCdI9pU++K4nD7to+jTcMIbXTSOcrLqUEW6gF2pU1UUbYJKc9cvcRSK1UDeMJ7pdMxf4bhMpV/A==} engines: {node: ^18.18.0 || >=20.0.0} '@ungap/structured-clone@1.2.0': @@ -5600,11 +5606,19 @@ packages: resolution: {integrity: sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + eslint-visitor-keys@4.0.0: + resolution: {integrity: sha512-OtIRv/2GyiF6o/d8K7MYKKbXrOUBIK6SfkIRM4Z0dY3w+LiQ0vy3F57m0Z71bjbyeiWFiHJ8brqnmE6H6/jEuw==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + eslint@8.57.0: resolution: {integrity: sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} hasBin: true + espree@10.1.0: + resolution: {integrity: sha512-M1M6CpiE6ffoigIOWYO9UDP8TMUw9kqb21tf+08IgDYjCsOvCuDt4jQcZmoYxx+w7zlKw9/N0KXfto+I8/FrXA==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + espree@9.6.1: resolution: {integrity: sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} @@ -8775,8 +8789,8 @@ packages: peerDependencies: typedoc-plugin-markdown: '>=4.0.0' - typedoc-plugin-markdown@4.2.1: - resolution: {integrity: sha512-7hQt/1WaW/VI4+x3sxwcCGsEylP1E1GvF6OTTELK5sfTEp6AeK+83jkCOgZGp1pI2DiOammMYQMnxxOny9TKsQ==} + typedoc-plugin-markdown@4.2.3: + resolution: {integrity: sha512-esucQj79SFYOv0f5XVha7QWdLUH5C5HRlDf7Z8CXzHedmVPn7jox6Gt7FdoBXN8AFxyHpa3Lbuxu65Dobwt+4Q==} engines: {node: '>= 18'} peerDependencies: typedoc: 0.26.x @@ -8794,8 +8808,8 @@ packages: types-react@19.0.0-rc.1: resolution: {integrity: sha512-RshndUfqTW6K3STLPis8BtAYCGOkMbtvYsi90gmVNDZBXUyUc5juf2PE9LfS/JmOlUIRO8cWTS/1MTnmhjDqyQ==} - typescript-eslint@7.16.1: - resolution: {integrity: sha512-889oE5qELj65q/tGeOSvlreNKhimitFwZqQ0o7PcWC7/lgRkAMknznsCsV8J8mZGTP/Z+cIbX8accf2DE33hrA==} + typescript-eslint@7.17.0: + resolution: {integrity: sha512-spQxsQvPguduCUfyUvLItvKqK3l8KJ/kqs5Pb/URtzQ5AC53Z6us32St37rpmlt2uESG23lOFpV4UErrmy4dZQ==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.56.0 @@ -12254,6 +12268,14 @@ snapshots: optionalDependencies: '@solidjs/router': 0.13.0(solid-js@1.8.18) + '@stylistic/eslint-plugin-js@2.3.0(eslint@8.57.0)': + dependencies: + '@types/eslint': 8.56.10 + acorn: 8.12.0 + eslint: 8.57.0 + eslint-visitor-keys: 4.0.0 + espree: 10.1.0 + '@swc/core-darwin-arm64@1.6.13': optional: true @@ -12318,10 +12340,11 @@ snapshots: '@tanstack/store': 0.5.5 tslib: 2.6.3 - '@tanstack/config@0.10.0(@types/node@20.14.10)(esbuild@0.21.5)(eslint@8.57.0)(rollup@4.18.0)(typescript@5.4.2)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1))': + '@tanstack/config@0.11.1(@types/node@20.14.10)(esbuild@0.21.5)(eslint@8.57.0)(rollup@4.18.0)(typescript@5.4.2)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1))': dependencies: '@commitlint/parse': 19.0.3 '@eslint/js': 8.57.0 + '@stylistic/eslint-plugin-js': 2.3.0(eslint@8.57.0) commander: 12.1.0 current-git-branch: 1.1.0 esbuild-register: 3.5.0(esbuild@0.21.5) @@ -12336,9 +12359,9 @@ snapshots: semver: 7.6.3 simple-git: 3.25.0 typedoc: 0.26.4(typescript@5.4.2) - typedoc-plugin-frontmatter: 1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.4.2))) - typedoc-plugin-markdown: 4.2.1(typedoc@0.26.4(typescript@5.4.2)) - typescript-eslint: 7.16.1(eslint@8.57.0)(typescript@5.4.2) + typedoc-plugin-frontmatter: 1.0.0(typedoc-plugin-markdown@4.2.3(typedoc@0.26.4(typescript@5.4.2))) + typedoc-plugin-markdown: 4.2.3(typedoc@0.26.4(typescript@5.4.2)) + typescript-eslint: 7.17.0(eslint@8.57.0)(typescript@5.4.2) v8flags: 4.0.1 vite-plugin-dts: 3.9.1(@types/node@20.14.10)(rollup@4.18.0)(typescript@5.4.2)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1)) vite-plugin-externalize-deps: 0.8.0(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.72.0)(sugarss@4.0.1)(terser@5.29.1)) @@ -12764,14 +12787,14 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/eslint-plugin@7.16.1(@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.4.2))(eslint@8.57.0)(typescript@5.4.2)': + '@typescript-eslint/eslint-plugin@7.17.0(@typescript-eslint/parser@7.17.0(eslint@8.57.0)(typescript@5.4.2))(eslint@8.57.0)(typescript@5.4.2)': dependencies: '@eslint-community/regexpp': 4.11.0 - '@typescript-eslint/parser': 7.16.1(eslint@8.57.0)(typescript@5.4.2) - '@typescript-eslint/scope-manager': 7.16.1 - '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.4.2) - '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.4.2) - '@typescript-eslint/visitor-keys': 7.16.1 + '@typescript-eslint/parser': 7.17.0(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/scope-manager': 7.17.0 + '@typescript-eslint/type-utils': 7.17.0(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/utils': 7.17.0(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/visitor-keys': 7.17.0 eslint: 8.57.0 graphemer: 1.4.0 ignore: 5.3.1 @@ -12795,12 +12818,12 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.4.2)': + '@typescript-eslint/parser@7.17.0(eslint@8.57.0)(typescript@5.4.2)': dependencies: - '@typescript-eslint/scope-manager': 7.16.1 - '@typescript-eslint/types': 7.16.1 - '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.4.2) - '@typescript-eslint/visitor-keys': 7.16.1 + '@typescript-eslint/scope-manager': 7.17.0 + '@typescript-eslint/types': 7.17.0 + '@typescript-eslint/typescript-estree': 7.17.0(typescript@5.4.2) + '@typescript-eslint/visitor-keys': 7.17.0 debug: 4.3.5 eslint: 8.57.0 optionalDependencies: @@ -12813,10 +12836,10 @@ snapshots: '@typescript-eslint/types': 7.16.0 '@typescript-eslint/visitor-keys': 7.16.0 - '@typescript-eslint/scope-manager@7.16.1': + '@typescript-eslint/scope-manager@7.17.0': dependencies: - '@typescript-eslint/types': 7.16.1 - '@typescript-eslint/visitor-keys': 7.16.1 + '@typescript-eslint/types': 7.17.0 + '@typescript-eslint/visitor-keys': 7.17.0 '@typescript-eslint/type-utils@7.16.0(eslint@8.57.0)(typescript@5.4.2)': dependencies: @@ -12830,10 +12853,10 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/type-utils@7.16.1(eslint@8.57.0)(typescript@5.4.2)': + '@typescript-eslint/type-utils@7.17.0(eslint@8.57.0)(typescript@5.4.2)': dependencies: - '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.4.2) - '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/typescript-estree': 7.17.0(typescript@5.4.2) + '@typescript-eslint/utils': 7.17.0(eslint@8.57.0)(typescript@5.4.2) debug: 4.3.5 eslint: 8.57.0 ts-api-utils: 1.3.0(typescript@5.4.2) @@ -12844,7 +12867,7 @@ snapshots: '@typescript-eslint/types@7.16.0': {} - '@typescript-eslint/types@7.16.1': {} + '@typescript-eslint/types@7.17.0': {} '@typescript-eslint/typescript-estree@7.16.0(typescript@5.4.2)': dependencies: @@ -12861,10 +12884,10 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/typescript-estree@7.16.1(typescript@5.4.2)': + '@typescript-eslint/typescript-estree@7.17.0(typescript@5.4.2)': dependencies: - '@typescript-eslint/types': 7.16.1 - '@typescript-eslint/visitor-keys': 7.16.1 + '@typescript-eslint/types': 7.17.0 + '@typescript-eslint/visitor-keys': 7.17.0 debug: 4.3.5 globby: 11.1.0 is-glob: 4.0.3 @@ -12887,12 +12910,12 @@ snapshots: - supports-color - typescript - '@typescript-eslint/utils@7.16.1(eslint@8.57.0)(typescript@5.4.2)': + '@typescript-eslint/utils@7.17.0(eslint@8.57.0)(typescript@5.4.2)': dependencies: '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) - '@typescript-eslint/scope-manager': 7.16.1 - '@typescript-eslint/types': 7.16.1 - '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.4.2) + '@typescript-eslint/scope-manager': 7.17.0 + '@typescript-eslint/types': 7.17.0 + '@typescript-eslint/typescript-estree': 7.17.0(typescript@5.4.2) eslint: 8.57.0 transitivePeerDependencies: - supports-color @@ -12903,9 +12926,9 @@ snapshots: '@typescript-eslint/types': 7.16.0 eslint-visitor-keys: 3.4.3 - '@typescript-eslint/visitor-keys@7.16.1': + '@typescript-eslint/visitor-keys@7.17.0': dependencies: - '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/types': 7.17.0 eslint-visitor-keys: 3.4.3 '@ungap/structured-clone@1.2.0': {} @@ -14509,7 +14532,7 @@ snapshots: eslint-plugin-import-x@3.0.1(eslint@8.57.0)(typescript@5.4.2): dependencies: '@rtsao/scc': 1.1.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/utils': 7.17.0(eslint@8.57.0)(typescript@5.4.2) debug: 4.3.5 doctrine: 3.0.0 eslint: 8.57.0 @@ -14650,6 +14673,8 @@ snapshots: eslint-visitor-keys@3.4.3: {} + eslint-visitor-keys@4.0.0: {} + eslint@8.57.0: dependencies: '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) @@ -14693,6 +14718,12 @@ snapshots: transitivePeerDependencies: - supports-color + espree@10.1.0: + dependencies: + acorn: 8.12.0 + acorn-jsx: 5.3.2(acorn@8.12.0) + eslint-visitor-keys: 4.0.0 + espree@9.6.1: dependencies: acorn: 8.12.0 @@ -18186,12 +18217,12 @@ snapshots: typed-assert@1.0.9: {} - typedoc-plugin-frontmatter@1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.4.2))): + typedoc-plugin-frontmatter@1.0.0(typedoc-plugin-markdown@4.2.3(typedoc@0.26.4(typescript@5.4.2))): dependencies: - typedoc-plugin-markdown: 4.2.1(typedoc@0.26.4(typescript@5.4.2)) + typedoc-plugin-markdown: 4.2.3(typedoc@0.26.4(typescript@5.4.2)) yaml: 2.4.5 - typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.4.2)): + typedoc-plugin-markdown@4.2.3(typedoc@0.26.4(typescript@5.4.2)): dependencies: typedoc: 0.26.4(typescript@5.4.2) @@ -18212,11 +18243,11 @@ snapshots: dependencies: csstype: 3.1.3 - typescript-eslint@7.16.1(eslint@8.57.0)(typescript@5.4.2): + typescript-eslint@7.17.0(eslint@8.57.0)(typescript@5.4.2): dependencies: - '@typescript-eslint/eslint-plugin': 7.16.1(@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.4.2))(eslint@8.57.0)(typescript@5.4.2) - '@typescript-eslint/parser': 7.16.1(eslint@8.57.0)(typescript@5.4.2) - '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/eslint-plugin': 7.17.0(@typescript-eslint/parser@7.17.0(eslint@8.57.0)(typescript@5.4.2))(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/parser': 7.17.0(eslint@8.57.0)(typescript@5.4.2) + '@typescript-eslint/utils': 7.17.0(eslint@8.57.0)(typescript@5.4.2) eslint: 8.57.0 optionalDependencies: typescript: 5.4.2