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

formOptions.md

76 lines2.0 KB

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