Skip to content

Commit f3d3dba

Browse files
ci: apply automated fixes and generate docs
1 parent c1f5747 commit f3d3dba

35 files changed

+256
-377
lines changed

docs/framework/react/reference/functions/useForm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: useForm
99
function useForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): ReactFormExtendedApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/react-form/src/useForm.tsx:159](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L159)
12+
Defined in: [packages/react-form/src/useForm.tsx:158](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L158)
1313

1414
A custom React Hook that returns an extended instance of the `FormApi` class.
1515

docs/framework/react/reference/functions/useStore.md

Lines changed: 19 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,80 +5,39 @@ title: useStore
55

66
# Function: useStore()
77

8-
## Call Signature
9-
10-
```ts
11-
function useStore<TState, TSelected>(
12-
store,
13-
selector?,
14-
options?): TSelected;
15-
```
16-
17-
Defined in: node\_modules/.pnpm/@tanstack[email protected]\_[email protected]\_[email protected]\_\_[email protected]/node\_modules/@tanstack/react-store/dist/esm/index.d.ts:11
18-
19-
### Type Parameters
20-
21-
#### TState
22-
23-
`TState`
24-
25-
#### TSelected
26-
27-
`TSelected` = `NoInfer`\<`TState`\>
28-
29-
### Parameters
30-
31-
#### store
32-
33-
`Store`\<`TState`, `any`\>
34-
35-
#### selector?
36-
37-
(`state`) => `TSelected`
38-
39-
#### options?
40-
41-
`UseStoreOptions`\<`TSelected`\>
42-
43-
### Returns
44-
45-
`TSelected`
46-
47-
## Call Signature
48-
498
```ts
50-
function useStore<TState, TSelected>(
51-
store,
52-
selector?,
53-
options?): TSelected;
9+
function useStore<TAtom, T>(
10+
atom,
11+
selector,
12+
compare?): T;
5413
```
5514

56-
Defined in: node\_modules/.pnpm/@tanstack+react-store@0.8.1\_[email protected]\_[email protected]\_\_[email protected]/node\_modules/@tanstack/react-store/dist/esm/index.d.ts:12
15+
Defined in: node\_modules/.pnpm/@tanstack+react-store@0.9.1\_[email protected]\_[email protected]\_\_[email protected]/node\_modules/@tanstack/react-store/dist/esm/useStore.d.ts:2
5716

58-
### Type Parameters
17+
## Type Parameters
5918

60-
#### TState
19+
### TAtom
6120

62-
`TState`
21+
`TAtom` *extends* `AnyAtom` \| `undefined`
6322

64-
#### TSelected
23+
### T
6524

66-
`TSelected` = `NoInfer`\<`TState`\>
25+
`T`
6726

68-
### Parameters
27+
## Parameters
6928

70-
#### store
29+
### atom
7130

72-
`Derived`\<`TState`, `any`\>
31+
`TAtom`
7332

74-
#### selector?
33+
### selector
7534

76-
(`state`) => `TSelected`
35+
(`snapshot`) => `T`
7736

78-
#### options?
37+
### compare?
7938

80-
`UseStoreOptions`\<`TSelected`\>
39+
(`a`, `b`) => `boolean`
8140

82-
### Returns
41+
## Returns
8342

84-
`TSelected`
43+
`T`

docs/framework/react/reference/interfaces/ReactFormApi.md

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

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

8-
Defined in: [packages/react-form/src/useForm.tsx:24](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L24)
8+
Defined in: [packages/react-form/src/useForm.tsx:23](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L23)
99

1010
Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm`
1111

@@ -67,7 +67,7 @@ Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned
6767
Field: FieldComponent<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
6868
```
6969

70-
Defined in: [packages/react-form/src/useForm.tsx:41](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L41)
70+
Defined in: [packages/react-form/src/useForm.tsx:40](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L40)
7171

7272
A React component to render form fields. With this, you can render and manage individual form fields.
7373

@@ -79,15 +79,15 @@ A React component to render form fields. With this, you can render and manage in
7979
Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;
8080
```
8181

82-
Defined in: [packages/react-form/src/useForm.tsx:58](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L58)
82+
Defined in: [packages/react-form/src/useForm.tsx:57](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L57)
8383

8484
A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates.
8585

8686
#### Type Parameters
8787

8888
##### TSelected
8989

90-
`TSelected` = `FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\>
90+
`TSelected` = `NoInfer`\<`FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\>\>
9191

9292
#### Parameters
9393

docs/framework/react/reference/type-aliases/ReactFormExtendedApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: ReactFormExtendedApi
99
type ReactFormExtendedApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> & ReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/react-form/src/useForm.tsx:99](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L99)
12+
Defined in: [packages/react-form/src/useForm.tsx:98](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L98)
1313

1414
An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi`
1515

docs/framework/solid/reference/functions/createFormHook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFormHook
99
function createFormHook<TComponents, TFormComponents>(opts): object;
1010
```
1111

12-
Defined in: [packages/solid-form/src/createFormHook.tsx:299](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L299)
12+
Defined in: [packages/solid-form/src/createFormHook.tsx:300](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L300)
1313

1414
## Type Parameters
1515

docs/framework/solid/reference/functions/createFormHookContexts.md

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

12-
Defined in: [packages/solid-form/src/createFormHook.tsx:68](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L68)
12+
Defined in: [packages/solid-form/src/createFormHook.tsx:69](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L69)
1313

1414
## Returns
1515

docs/framework/solid/reference/functions/useStore.md

Lines changed: 10 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -5,80 +5,39 @@ title: useStore
55

66
# Function: useStore()
77

8-
## Call Signature
9-
10-
```ts
11-
function useStore<TState, TSelected>(
12-
store,
13-
selector?,
14-
options?): Accessor<TSelected>;
15-
```
16-
17-
Defined in: node\_modules/.pnpm/@tanstack[email protected]\_[email protected]/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:12
18-
19-
### Type Parameters
20-
21-
#### TState
22-
23-
`TState`
24-
25-
#### TSelected
26-
27-
`TSelected` = `NoInfer`\<`TState`\>
28-
29-
### Parameters
30-
31-
#### store
32-
33-
`Store`\<`TState`, `any`\>
34-
35-
#### selector?
36-
37-
(`state`) => `TSelected`
38-
39-
#### options?
40-
41-
`UseStoreOptions`\<`TSelected`\>
42-
43-
### Returns
44-
45-
`Accessor`\<`TSelected`\>
46-
47-
## Call Signature
48-
498
```ts
509
function useStore<TState, TSelected>(
5110
store,
5211
selector?,
5312
options?): Accessor<TSelected>;
5413
```
5514

56-
Defined in: node\_modules/.pnpm/@tanstack+solid-store@0.8.1\_[email protected]/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:13
15+
Defined in: node\_modules/.pnpm/@tanstack+solid-store@0.9.1\_[email protected]/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:8
5716

58-
### Type Parameters
17+
## Type Parameters
5918

60-
#### TState
19+
### TState
6120

6221
`TState`
6322

64-
#### TSelected
23+
### TSelected
6524

6625
`TSelected` = `NoInfer`\<`TState`\>
6726

68-
### Parameters
27+
## Parameters
6928

70-
#### store
29+
### store
7130

72-
`Derived`\<`TState`, `any`\>
31+
`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>
7332

74-
#### selector?
33+
### selector?
7534

7635
(`state`) => `TSelected`
7736

78-
#### options?
37+
### options?
7938

8039
`UseStoreOptions`\<`TSelected`\>
8140

82-
### Returns
41+
## Returns
8342

8443
`Accessor`\<`TSelected`\>

docs/framework/solid/reference/interfaces/WithFieldGroupProps.md

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

66
# Interface: WithFieldGroupProps\<TFieldGroupData, TFieldComponents, TFormComponents, TSubmitMeta, TRenderProps\>
77

8-
Defined in: [packages/solid-form/src/createFormHook.tsx:262](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L262)
8+
Defined in: [packages/solid-form/src/createFormHook.tsx:263](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L263)
99

1010
## Extends
1111

@@ -41,7 +41,7 @@ Defined in: [packages/solid-form/src/createFormHook.tsx:262](https://github.com/
4141
optional props: TRenderProps;
4242
```
4343

44-
Defined in: [packages/solid-form/src/createFormHook.tsx:270](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L270)
44+
Defined in: [packages/solid-form/src/createFormHook.tsx:271](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L271)
4545

4646
***
4747

@@ -51,7 +51,7 @@ Defined in: [packages/solid-form/src/createFormHook.tsx:270](https://github.com/
5151
render: (props) => Element;
5252
```
5353

54-
Defined in: [packages/solid-form/src/createFormHook.tsx:271](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L271)
54+
Defined in: [packages/solid-form/src/createFormHook.tsx:272](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L272)
5555

5656
#### Parameters
5757

docs/framework/solid/reference/interfaces/WithFormProps.md

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

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

8-
Defined in: [packages/solid-form/src/createFormHook.tsx:206](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L206)
8+
Defined in: [packages/solid-form/src/createFormHook.tsx:207](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L207)
99

1010
## Extends
1111

@@ -81,7 +81,7 @@ Defined in: [packages/solid-form/src/createFormHook.tsx:206](https://github.com/
8181
optional props: TRenderProps;
8282
```
8383

84-
Defined in: [packages/solid-form/src/createFormHook.tsx:237](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L237)
84+
Defined in: [packages/solid-form/src/createFormHook.tsx:238](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L238)
8585

8686
***
8787

@@ -91,7 +91,7 @@ Defined in: [packages/solid-form/src/createFormHook.tsx:237](https://github.com/
9191
render: (props) => Element;
9292
```
9393

94-
Defined in: [packages/solid-form/src/createFormHook.tsx:238](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L238)
94+
Defined in: [packages/solid-form/src/createFormHook.tsx:239](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L239)
9595

9696
#### Parameters
9797

docs/framework/vue/reference/functions/useForm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: useForm
99
function useForm<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>(opts?): FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta> & VueFormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/vue-form/src/useForm.tsx:217](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L217)
12+
Defined in: [packages/vue-form/src/useForm.tsx:216](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L216)
1313

1414
## Type Parameters
1515

0 commit comments

Comments
 (0)