PersistedReadinessSource

Defined in: packages/db/src/persisted-readiness.ts:10

Internal

Capability supplied by a persistence adapter, not by core sync.

Properties#

getOrStartNetworkDeadline()#

getOrStartNetworkDeadline: () => number;

Defined in: packages/db/src/persisted-readiness.ts:14

Anchor the deadline to this Collection's current sync run.

Returns#

number

getSnapshot()#

getSnapshot: () => PersistedReadinessSnapshot;

Defined in: packages/db/src/persisted-readiness.ts:15

Returns#

PersistedReadinessSnapshot

networkTimeoutMs#

networkTimeoutMs: number;

Defined in: packages/db/src/persisted-readiness.ts:12

Time to prefer network before a completed persisted restore may render.

subscribe()#

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

Defined in: packages/db/src/persisted-readiness.ts:16

Parameters#

listener#

() => void

Returns#

(): void;

Returns#

void

waitForInitialRender()#

waitForInitialRender: (__namedParameters) => object;

Defined in: packages/db/src/persisted-readiness.ts:22

The network-first initial-render wait, normally waitForPersistedInitialRender. A persistence adapter supplies it with its readiness, so an app with no persisted Collection does not ship it.

Resolve when network data is ready, or when the network deadline passes or the network fails while every persisted source has restored. Reject with the network error when no persisted fallback may render.

Parameters#

__namedParameters#

PersistedInitialRenderInput

Returns#

object

cancel()#

cancel: () => void;

Returns#

void

promise#

promise: Promise<void>;