Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

mergeForm.md

76 lines2.2 KB

1---
2id: mergeForm
3title: mergeForm
4---
5​
6# Function: mergeForm()
7​
8```ts
9function mergeForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(baseForm, state): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
10```
11​
12Defined in: [packages/form-core/src/mergeForm.ts:77](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L77)
13​
14## Type Parameters
15​
16### TFormData
17​
18`TFormData`
19​
20### TOnMount
21​
22`TOnMount` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
23​
24### TOnChange
25​
26`TOnChange` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
27​
28### TOnChangeAsync
29​
30`TOnChangeAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
31​
32### TOnBlur
33​
34`TOnBlur` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
35​
36### TOnBlurAsync
37​
38`TOnBlurAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
39​
40### TOnSubmit
41​
42`TOnSubmit` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
43​
44### TOnSubmitAsync
45​
46`TOnSubmitAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
47​
48### TOnDynamic
49​
50`TOnDynamic` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
51​
52### TOnDynamicAsync
53​
54`TOnDynamicAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
55​
56### TOnServer
57​
58`TOnServer` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
59​
60### TSubmitMeta
61​
62`TSubmitMeta` = `never`
63​
64## Parameters
65​
66### baseForm
67​
68[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
69​
70### state
71​
72`Partial`\<[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\[`"state"`\]\>
73​
74## Returns
75​
76[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>