- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
LiveQueryWindowController
Defined in: packages/db/src/live-query-window-controller.ts:553
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:564
Returns#
void
fetchNextPage()#
fetchNextPage: () => Promise<void>;Defined in: packages/db/src/live-query-window-controller.ts:560
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:557
Returns#
LiveQueryWindowSnapshot<T, TKey>
preload()#
preload: () => Promise<void>;Defined in: packages/db/src/live-query-window-controller.ts:563
Returns#
Promise<void>
reset()#
reset: () => Promise<void>;Defined in: packages/db/src/live-query-window-controller.ts:562
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:558
Parameters#
listener#
() => void
Returns#
(): void;Returns#
void