Skip to main content

PostCustomCheckpoints

Extended by​

Methods​

postCheckpointRequest()?​

optional postCheckpointRequest(
clientId,
requestId,
signal?): Promise<string>;

Posts a client-generated checkpoint request to the backend and returns the effective checkpoint request state.

This method is optional. It only needs to be implemented when the selected CheckpointMode is requests and asynchronous backend uploads are used. In any other case, this method should not be present on backend connectors.

Parameters​

ParameterTypeDescription
clientIdstringThe PowerSync client ID for the current device.
requestIdstringThe client-generated checkpoint request ID (a positive 64-bit integer encoded as a string).
signal?AbortSignalAn optional abort signal that completes when the checkpoint is no longer necessary.

Returns​

Promise<string>