Interface: LiveQueryWindowSnapshot<T, TKey>#
Defined in: packages/db/src/live-query-window-controller.ts:474
Internal
A page-windowed view of a live query at a point in time.
This contract is unstable while RFC #1623 is being implemented.
Type Parameters#
T#
T extends object
TKey#
TKey extends string | number
Properties#
collection#
collection:
| Collection<T, TKey, any, StandardSchemaV1<unknown, unknown>, T>
| undefined;
Defined in: packages/db/src/live-query-window-controller.ts:490
data#
data: readonly T[];
Defined in: packages/db/src/live-query-window-controller.ts:479
Rows across all committed pages, with the peek-ahead row removed.
error#
error: unknown;
Defined in: packages/db/src/live-query-window-controller.ts:487
The last pagination failure, cleared when a retry begins.
hasNextPage#
hasNextPage: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:484
isCleanedUp#
isCleanedUp: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:496
isEnabled#
isEnabled: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:497
isError#
isError: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:495
isFetchingNextPage#
isFetchingNextPage: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:485
isIdle#
isIdle: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:494
isLoading#
isLoading: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:492
isReady#
isReady: boolean;
Defined in: packages/db/src/live-query-window-controller.ts:493
pageParams#
pageParams: readonly number[];
Defined in: packages/db/src/live-query-window-controller.ts:483
initialPageParam + i for each committed page.
pages#
pages: readonly readonly T[][];
Defined in: packages/db/src/live-query-window-controller.ts:481
Rows grouped into committed pages of pageSize.
state#
state: ReadonlyMap<TKey, T> | undefined;
Defined in: packages/db/src/live-query-window-controller.ts:489
Keyed results for the physical window, or undefined when disabled.
status#
status: CollectionStatus | "disabled";
Defined in: packages/db/src/live-query-window-controller.ts:491