LiveQueryWindowSnapshot

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

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

ts

collection: 
  | Collection<T, TKey, any, StandardSchemaV1<unknown, unknown>, T>
  | undefined;

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

data

ts

data: readonly T[];

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

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

hasNextPage

ts

hasNextPage: boolean;

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

health

ts

health: HealthNode | undefined;

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

The health tree for the collection and its dependencies, or undefined when disabled.

isCleanedUp

ts

isCleanedUp: boolean;

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

isCrashed

ts

isCrashed: boolean;

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

isEnabled

ts

isEnabled: boolean;

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

isFetchingNextPage

ts

isFetchingNextPage: boolean;

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

isIdle

ts

isIdle: boolean;

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

isLoading

ts

isLoading: boolean;

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

isLoadingError

ts

isLoadingError: boolean;

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

isReady

ts

isReady: boolean;

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

isSyncError

ts

isSyncError: boolean;

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

The data is shown, and a sync problem or failed page load is in health.

pageParams

ts

pageParams: readonly number[];

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

initialPageParam + i for each committed page.

pages

ts

pages: readonly readonly T[][];

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

Rows grouped into committed pages of pageSize.

state

ts

state: ReadonlyMap<TKey, T> | undefined;

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

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

status

ts

status: CollectionStatus | "disabled";

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

NextCore API Reference