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

LiveQueryWindowSnapshot.md

214 lines4.7 KB

1---
2id: LiveQueryWindowSnapshot
3title: LiveQueryWindowSnapshot
4---
5​
6Defined in: [packages/db/src/live-query-window-controller.ts:477](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L477)
7​
8**`Internal`**
9​
10A page-windowed view of a live query at a point in time.
11​
12 This contract is unstable while RFC #1623 is being implemented.
13​
14## Type Parameters
15​
16### T
17​
18`T` *extends* `object`
19​
20### TKey
21​
22`TKey` *extends* `string` \| `number`
23​
24## Properties
25​
26### collection
27​
28```ts
29collection:
30 | Collection<T, TKey, any, StandardSchemaV1<unknown, unknown>, T>
31 | undefined;
32```
33​
34Defined in: [packages/db/src/live-query-window-controller.ts:493](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L493)
35​
36***
37​
38### data
39​
40```ts
41data: readonly T[];
42```
43​
44Defined in: [packages/db/src/live-query-window-controller.ts:482](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L482)
45​
46Rows across all committed pages, with the peek-ahead row removed.
47​
48***
49​
50### error
51​
52```ts
53error: unknown;
54```
55​
56Defined in: [packages/db/src/live-query-window-controller.ts:490](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L490)
57​
58Last pagination failure, retained through an earlier-started success until recovery begins.
59​
60***
61​
62### hasNextPage
63​
64```ts
65hasNextPage: boolean;
66```
67​
68Defined in: [packages/db/src/live-query-window-controller.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L487)
69​
70***
71​
72### isCleanedUp
73​
74```ts
75isCleanedUp: boolean;
76```
77​
78Defined in: [packages/db/src/live-query-window-controller.ts:502](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L502)
79​
80***
81​
82### isEnabled
83​
84```ts
85isEnabled: boolean;
86```
87​
88Defined in: [packages/db/src/live-query-window-controller.ts:503](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L503)
89​
90***
91​
92### isError
93​
94```ts
95isError: boolean;
96```
97​
98Defined in: [packages/db/src/live-query-window-controller.ts:501](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L501)
99​
100***
101​
102### isFetchingNextPage
103​
104```ts
105isFetchingNextPage: boolean;
106```
107​
108Defined in: [packages/db/src/live-query-window-controller.ts:488](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L488)
109​
110***
111​
112### isIdle
113​
114```ts
115isIdle: boolean;
116```
117​
118Defined in: [packages/db/src/live-query-window-controller.ts:500](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L500)
119​
120***
121​
122### isLoading
123​
124```ts
125isLoading: boolean;
126```
127​
128Defined in: [packages/db/src/live-query-window-controller.ts:495](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L495)
129​
130***
131​
132### isPersistedReady
133​
134```ts
135isPersistedReady: boolean;
136```
137​
138Defined in: [packages/db/src/live-query-window-controller.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L498)
139​
140***
141​
142### isReady
143​
144```ts
145isReady: boolean;
146```
147​
148Defined in: [packages/db/src/live-query-window-controller.ts:496](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L496)
149​
150***
151​
152### pageParams
153​
154```ts
155pageParams: readonly number[];
156```
157​
158Defined in: [packages/db/src/live-query-window-controller.ts:486](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L486)
159​
160`initialPageParam + i` for each committed page.
161​
162***
163​
164### pages
165​
166```ts
167pages: readonly readonly T[][];
168```
169​
170Defined in: [packages/db/src/live-query-window-controller.ts:484](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L484)
171​
172Rows grouped into committed pages of `pageSize`.
173​
174***
175​
176### persistedError
177​
178```ts
179persistedError: unknown;
180```
181​
182Defined in: [packages/db/src/live-query-window-controller.ts:499](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L499)
183​
184***
185​
186### persistedStatus
187​
188```ts
189persistedStatus: LiveQueryPersistedStatus;
190```
191​
192Defined in: [packages/db/src/live-query-window-controller.ts:497](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L497)
193​
194***
195​
196### state
197​
198```ts
199state: ReadonlyMap<TKey, T> | undefined;
200```
201​
202Defined in: [packages/db/src/live-query-window-controller.ts:492](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L492)
203​
204Keyed results for the physical window, or `undefined` when disabled.
205​
206***
207​
208### status
209​
210```ts
211status: CollectionStatus | "disabled";
212```
213​
214Defined in: [packages/db/src/live-query-window-controller.ts:494](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L494)