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

createFormHook.test-d.tsx

86 lines1.9 KB

1import { expectTypeOf } from 'vitest'
2import { createFormHook } from '../src'
3​
4const { useAppForm } = createFormHook({
5 fieldComponents: {},
6 formComponents: {},
7 defaultFormOptions: {
8 listenersMerge: 'append',
9 listeners: [
10 {
11 triggers: [],
12 run: ({ value }) => {
13 expectTypeOf(value).toBeUnknown()
14 },
15 },
16 ],
17 },
18 defaultFieldOptions: {
19 listenersMerge: 'prepend',
20 listeners: [
21 {
22 triggers: [],
23 run: ({ value, fieldApi }) => {
24 expectTypeOf(value).toBeUnknown()
25 expectTypeOf(fieldApi.value).toBeUnknown()
26 },
27 },
28 ],
29 },
30 defaultFormGroupOptions: {
31 onSubmitInvalid: ({ value, groupApi }) => {
32 expectTypeOf(value).toBeUnknown()
33 expectTypeOf(groupApi.value).toBeUnknown()
34 },
35 },
36})
37​
38function InferenceRemainsLocal() {
39 const form = useAppForm(() => ({
40 defaultValues: {
41 name: '',
42 tags: [''],
43 group: { count: 0 },
44 },
45 }))
46​
47 expectTypeOf(form.state.values).toEqualTypeOf<{
48 name: string
49 tags: Array<string>
50 group: { count: number }
51 }>()
52​
53 return (
54 <>
55 <form.Field name="name">
56 {(field) => {
57 expectTypeOf(field().value).toEqualTypeOf<string>()
58 return null
59 }}
60 </form.Field>
61 <form.ArrayField name="tags">
62 {(field) => {
63 expectTypeOf(field().value).toEqualTypeOf<Array<string>>()
64 return null
65 }}
66 </form.ArrayField>
67 <form.FormGroup name="group">
68 {(group) => {
69 expectTypeOf(group().value).toEqualTypeOf<{ count: number }>()
70 return null
71 }}
72 </form.FormGroup>
73 </>
74 )
76​
77void InferenceRemainsLocal
78​
79createFormHook({
80 fieldComponents: {},
81 formComponents: {},
82 defaultFormOptions: {
83 // @ts-expect-error formId belongs to an individual form instance
84 formId: 'profile',
85 },
86})