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

derived.md

232 lines3.6 KB

1---
2id: Derived
3title: Derived
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8# Class: Derived\<TState, TArr\>
9​
10Defined in: [derived.ts:54](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L54)
11​
12## Type Parameters
13​
14β€’ **TState**
15​
16β€’ **TArr** *extends* `ReadonlyArray`\<[`Derived`](../derived.md)\<`any`\> \| [`Store`](../store.md)\<`any`\>\> = `ReadonlyArray`\<`any`\>
17​
18## Constructors
19​
20### new Derived()
21​
22```ts
23new Derived<TState, TArr>(options): Derived<TState, TArr>
24```
25​
26Defined in: [derived.ts:87](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L87)
27​
28#### Parameters
29​
30##### options
31​
32[`DerivedOptions`](../../interfaces/derivedoptions.md)\<`TState`, `TArr`\>
33​
34#### Returns
35​
36[`Derived`](../derived.md)\<`TState`, `TArr`\>
37​
38## Properties
39​
40### lastSeenDepValues
41​
42```ts
43lastSeenDepValues: unknown[] = [];
44```
45​
46Defined in: [derived.ts:71](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L71)
47​
48***
49​
50### listeners
51​
52```ts
53listeners: Set<Listener<TState>>;
54```
55​
56Defined in: [derived.ts:60](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L60)
57​
58***
59​
60### options
61​
62```ts
63options: DerivedOptions<TState, TArr>;
64```
65​
66Defined in: [derived.ts:63](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L63)
67​
68***
69​
70### prevState
71​
72```ts
73prevState: undefined | TState;
74```
75​
76Defined in: [derived.ts:62](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L62)
77​
78***
79​
80### state
81​
82```ts
83state: TState;
84```
85​
86Defined in: [derived.ts:61](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L61)
87​
88## Methods
89​
90### checkIfRecalculationNeededDeeply()
91​
92```ts
93checkIfRecalculationNeededDeeply(): void
94```
95​
96Defined in: [derived.ts:157](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L157)
97​
98#### Returns
99​
100`void`
101​
102***
103​
104### getDepVals()
105​
106```ts
107getDepVals(): object
108```
109​
110Defined in: [derived.ts:72](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L72)
111​
112#### Returns
113​
114`object`
115​
116##### currDepVals
117​
118```ts
119currDepVals: unknown[];
120```
121​
122##### prevDepVals
123​
124```ts
125prevDepVals: unknown[];
126```
127​
128##### prevVal
129​
130```ts
131prevVal: undefined | NonNullable<TState>;
132```
133​
134***
135​
136### mount()
137​
138```ts
139mount(): () => void
140```
141​
142Defined in: [derived.ts:178](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L178)
143​
144#### Returns
145​
146`Function`
147​
148##### Returns
149​
150`void`
151​
152***
153​
154### recompute()
155​
156```ts
157recompute(): void
158```
159​
160Defined in: [derived.ts:145](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L145)
161​
162#### Returns
163​
164`void`
165​
166***
167​
168### registerOnGraph()
169​
170```ts
171registerOnGraph(deps): void
172```
173​
174Defined in: [derived.ts:96](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L96)
175​
176#### Parameters
177​
178##### deps
179​
180readonly (
181 \| [`Derived`](../derived.md)\<`any`, readonly `any`[]\>
182 \| [`Store`](../store.md)\<`any`, (`cb`) => `any`\>)[] = `...`
183​
184#### Returns
185​
186`void`
187​
188***
189​
190### subscribe()
191​
192```ts
193subscribe(listener): () => void
194```
195​
196Defined in: [derived.ts:190](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L190)
197​
198#### Parameters
199​
200##### listener
201​
202`Listener`\<`TState`\>
203​
204#### Returns
205​
206`Function`
207​
208##### Returns
209​
210`void`
211​
212***
213​
214### unregisterFromGraph()
215​
216```ts
217unregisterFromGraph(deps): void
218```
219​
220Defined in: [derived.ts:125](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L125)
221​
222#### Parameters
223​
224##### deps
225​
226readonly (
227 \| [`Derived`](../derived.md)\<`any`, readonly `any`[]\>
228 \| [`Store`](../store.md)\<`any`, (`cb`) => `any`\>)[] = `...`
229​
230#### Returns
231​
232`void`