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

SubscribeProps.md

76 lines1.3 KB

1---
2id: SubscribeProps
3title: SubscribeProps
4---
5​
6Defined in: [packages/solid-form/src/Subscribe.public.ts:14](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L14)
7​
8## Type Parameters
9​
10### TSourceData
11​
12`TSourceData`
13​
14### TSelected
15​
16`TSelected`
17​
18## Properties
19​
20### children
21​
22```ts
23children: Element | ((state) => Element);
24```
25​
26Defined in: [packages/solid-form/src/Subscribe.public.ts:18](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L18)
27​
28***
29​
30### selector
31​
32```ts
33selector: (state) => TSelected;
34```
35​
36Defined in: [packages/solid-form/src/Subscribe.public.ts:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L16)
37​
38#### Parameters
39​
40##### state
41​
42`TSourceData`
43​
44#### Returns
45​
46`TSelected`
47​
48***
49​
50### source
51​
52```ts
53source: SubscribeSource<TSourceData>;
54```
55​
56Defined in: [packages/solid-form/src/Subscribe.public.ts:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L15)
57​
58***
59​
60### when?
61​
62```ts
63optional when?: (selected) => boolean;
64```
65​
66Defined in: [packages/solid-form/src/Subscribe.public.ts:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L17)
67​
68#### Parameters
69​
70##### selected
71​
72`NoInfer`\<`TSelected`\>
73​
74#### Returns
75​
76`boolean`