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

LiveQueryWindowController.md

122 lines2.3 KB

Interface: LiveQueryWindowController<T, TKey>

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

Internal

This contract is unstable while RFC #1623 is being implemented.

Type Parameters

T

T extends object

TKey

TKey extends string | number

Properties

dispose()

dispose: () => void;

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

Returns

void


fetchNextPage()

fetchNextPage: () => Promise<void>;

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

Load one more page, resolving only after that page is committed.

Returns

Promise<void>


getSnapshot()

getSnapshot: () => LiveQueryWindowSnapshot<T, TKey>;

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

Returns

LiveQueryWindowSnapshot<T, TKey>


preload()

preload: () => Promise<void>;

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

Returns

Promise<void>


reset()

reset: () => Promise<void>;

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

Reset to the first page, resolving after the smaller window is accepted.

Returns

Promise<void>


subscribe()

subscribe: (listener) => () => void;

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

Parameters

listener

() => void

Returns

(): void;
Returns

void