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

SubscribeProps.md

66 lines1.1 KB

1---
2id: SubscribeProps
3title: SubscribeProps
4---
5​
6Defined in: [packages/vue-form/src/Subscribe.public.ts:14](https://github.com/TanStack/form/blob/main/packages/vue-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### selector
21​
22```ts
23selector: (state) => TSelected;
24```
25​
26Defined in: [packages/vue-form/src/Subscribe.public.ts:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L16)
27​
28#### Parameters
29​
30##### state
31​
32`TSourceData`
33​
34#### Returns
35​
36`TSelected`
37​
38***
39​
40### source
41​
42```ts
43source: SubscribeSource<TSourceData>;
44```
45​
46Defined in: [packages/vue-form/src/Subscribe.public.ts:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L15)
47​
48***
49​
50### when?
51​
52```ts
53optional when?: (selected) => boolean;
54```
55​
56Defined in: [packages/vue-form/src/Subscribe.public.ts:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L17)
57​
58#### Parameters
59​
60##### selected
61​
62`NoInfer`\<`TSelected`\>
63​
64#### Returns
65​
66`boolean`