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

LiveQueryWindowSnapshot.md

186 lines4.0 KB

1---
2id: LiveQueryWindowSnapshot
3title: LiveQueryWindowSnapshot
4---
5​
6# Interface: LiveQueryWindowSnapshot\<T, TKey\>
7​
8Defined in: [packages/db/src/live-query-window-controller.ts:474](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L474)
9​
10**`Internal`**
11​
12A page-windowed view of a live query at a point in time.
13​
14 This contract is unstable while RFC #1623 is being implemented.
15​
16## Type Parameters
17​
18### T
19​
20`T` *extends* `object`
21​
22### TKey
23​
24`TKey` *extends* `string` \| `number`
25​
26## Properties
27​
28### collection
29​
30```ts
31collection:
32 | Collection<T, TKey, any, StandardSchemaV1<unknown, unknown>, T>
33 | undefined;
34```
35​
36Defined 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)
37​
38***
39​
40### data
41​
42```ts
43data: readonly T[];
44```
45​
46Defined in: [packages/db/src/live-query-window-controller.ts:479](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L479)
47​
48Rows across all committed pages, with the peek-ahead row removed.
49​
50***
51​
52### error
53​
54```ts
55error: unknown;
56```
57​
58Defined 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)
59​
60The last pagination failure, cleared when a retry begins.
61​
62***
63​
64### hasNextPage
65​
66```ts
67hasNextPage: boolean;
68```
69​
70Defined 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)
71​
72***
73​
74### isCleanedUp
75​
76```ts
77isCleanedUp: boolean;
78```
79​
80Defined 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)
81​
82***
83​
84### isEnabled
85​
86```ts
87isEnabled: boolean;
88```
89​
90Defined 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)
91​
92***
93​
94### isError
95​
96```ts
97isError: boolean;
98```
99​
100Defined 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)
101​
102***
103​
104### isFetchingNextPage
105​
106```ts
107isFetchingNextPage: boolean;
108```
109​
110Defined in: [packages/db/src/live-query-window-controller.ts:485](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L485)
111​
112***
113​
114### isIdle
115​
116```ts
117isIdle: boolean;
118```
119​
120Defined 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)
121​
122***
123​
124### isLoading
125​
126```ts
127isLoading: boolean;
128```
129​
130Defined 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)
131​
132***
133​
134### isReady
135​
136```ts
137isReady: boolean;
138```
139​
140Defined 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)
141​
142***
143​
144### pageParams
145​
146```ts
147pageParams: readonly number[];
148```
149​
150Defined in: [packages/db/src/live-query-window-controller.ts:483](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L483)
151​
152`initialPageParam + i` for each committed page.
153​
154***
155​
156### pages
157​
158```ts
159pages: readonly readonly T[][];
160```
161​
162Defined in: [packages/db/src/live-query-window-controller.ts:481](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L481)
163​
164Rows grouped into committed pages of `pageSize`.
165​
166***
167​
168### state
169​
170```ts
171state: ReadonlyMap<TKey, T> | undefined;
172```
173​
174Defined in: [packages/db/src/live-query-window-controller.ts:489](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L489)
175​
176Keyed results for the physical window, or `undefined` when disabled.
177​
178***
179​
180### status
181​
182```ts
183status: CollectionStatus | "disabled";
184```
185​
186Defined in: [packages/db/src/live-query-window-controller.ts:491](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L491)