CheckpointRequest

Alpha

A checkpoint request created by CommonPowerSyncDatabase#requestCheckpoint.

Use this value to wait until the local database has applied server-side changes up to the requested checkpoint. This is useful for explicit refresh flows where the caller wants confirmation that the local view has caught up to the service.

Checkpoint requests are backed by request ids tracked in the local database, so they are reusable across disconnect and reconnect cycles. A wait interrupted by a disconnect throws an error, but the same request can be awaited again once a new connection is established.

Requests do not survive CommonPowerSyncDatabase#disconnectAndClear, instances created before a clear should be discarded and requested again.

Properties

Property	Modifier	Type	Description
hasSynced	readonly	boolean	Alpha Whether this checkpoint request has synced before.

Methods

waitForSync()

waitForSync(options?): Promise<void>;

Alpha

Waits until this checkpoint has been synced locally.

This method fails on sync errors: If a download or upload error occurs before this checkpoint request has synced, that error is rethrown here. This makes it easier to observe sync errors when relying on checkpoints. Once sync has recovered, it is valid to call this method again to await the checkpoint.

Parameters

Parameter	Type
options?	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<void>