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

derivedoptions.md

92 lines1.5 KB

1---
2id: DerivedOptions
3title: DerivedOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8# Interface: DerivedOptions\<TState, TArr\>
9​
10Defined in: [derived.ts:38](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L38)
11​
12## Type Parameters
13​
14β€’ **TState**
15​
16β€’ **TArr** *extends* `ReadonlyArray`\<
17 \| [`Derived`](../../classes/derived.md)\<`any`\>
18 \| [`Store`](../../classes/store.md)\<`any`\>\> = `ReadonlyArray`\<`any`\>
19​
20## Properties
21​
22### deps
23​
24```ts
25deps: TArr;
26```
27​
28Defined in: [derived.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L47)
29​
30***
31​
32### fn()
33​
34```ts
35fn: (props) => TState;
36```
37​
38Defined in: [derived.ts:51](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L51)
39​
40Values of the `deps` from before and after the current invocation of `fn`
41​
42#### Parameters
43​
44##### props
45​
46[`DerivedFnProps`](../derivedfnprops.md)\<`TArr`\>
47​
48#### Returns
49​
50`TState`
51​
52***
53​
54### onSubscribe()?
55​
56```ts
57optional onSubscribe: (listener, derived) => () => void;
58```
59​
60Defined in: [derived.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L42)
61​
62#### Parameters
63​
64##### listener
65​
66`Listener`\<`TState`\>
67​
68##### derived
69​
70[`Derived`](../../classes/derived.md)\<`TState`\>
71​
72#### Returns
73​
74`Function`
75​
76##### Returns
77​
78`void`
79​
80***
81​
82### onUpdate()?
83​
84```ts
85optional onUpdate: () => void;
86```
87​
88Defined in: [derived.ts:46](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L46)
89​
90#### Returns
91​
92`void`