- 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
PersistedInitialRenderInput
Defined in: packages/db/src/persisted-readiness.ts:33
Internal
What a live query observer passes to the initial-render wait.
Properties#
clientQuery#
clientQuery: InitialRenderClientQuery | undefined;Defined in: packages/db/src/persisted-readiness.ts:41
The client query stream at the start of the wait, if any.
collectionStatus()#
collectionStatus: () => string | undefined;Defined in: packages/db/src/persisted-readiness.ts:45
The live query Collection's status now.
Returns#
string | undefined
currentClientQuery()#
currentClientQuery: () => unknown;Defined in: packages/db/src/persisted-readiness.ts:43
The client query stream now, for a failed stream's identity.
Returns#
unknown
network#
network: Promise<void>;Defined in: packages/db/src/persisted-readiness.ts:39
The network preload that this render prefers.
onReady()#
onReady: () => void;Defined in: packages/db/src/persisted-readiness.ts:48
Runs once the render may proceed, before the promise resolves.
Returns#
void
readPersisted()#
readPersisted: () => object;Defined in: packages/db/src/persisted-readiness.ts:46
Returns#
object
error#
error: unknown;status#
status: string;sources#
sources: readonly object[];Defined in: packages/db/src/persisted-readiness.ts:34