LiveQueryWindowSnapshot

Defined in: packages/db/src/live-query-window-controller.ts:513

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:529

data

data: readonly T[];

Defined in: packages/db/src/live-query-window-controller.ts:518

Rows across all committed pages, with the peek-ahead row removed.

error

error: unknown;

Defined in: packages/db/src/live-query-window-controller.ts:526

Last pagination failure, retained through an earlier-started success until recovery begins.

hasNextPage

hasNextPage: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:523

isCleanedUp

isCleanedUp: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:538

isEnabled

isEnabled: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:539

isError

isError: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:537

isFetchingNextPage

isFetchingNextPage: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:524

isIdle

isIdle: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:536

isLoading

isLoading: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:531

isPersistedReady

isPersistedReady: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:534

isReady

isReady: boolean;

Defined in: packages/db/src/live-query-window-controller.ts:532

pageParams

pageParams: readonly number[];

Defined in: packages/db/src/live-query-window-controller.ts:522

initialPageParam + i for each committed page.

pages

pages: readonly readonly T[][];

Defined in: packages/db/src/live-query-window-controller.ts:520

Rows grouped into committed pages of pageSize.

persistedError

persistedError: unknown;

Defined in: packages/db/src/live-query-window-controller.ts:535

persistedStatus

persistedStatus: LiveQueryPersistedStatus;

Defined in: packages/db/src/live-query-window-controller.ts:533

state

state: ReadonlyMap<TKey, T> | undefined;

Defined in: packages/db/src/live-query-window-controller.ts:528

Keyed results for the physical window, or undefined when disabled.

status

status: CollectionStatus | "disabled";

Defined in: packages/db/src/live-query-window-controller.ts:530