Skip to main content

WebStreamingSyncImplementation

Extends

Extended by

Constructors

new WebStreamingSyncImplementation()

new WebStreamingSyncImplementation(options): WebStreamingSyncImplementation

Parameters

ParameterType
optionsWebStreamingSyncImplementationOptions

Returns

WebStreamingSyncImplementation

Overrides

AbstractStreamingSyncImplementation.constructor

Properties

PropertyTypeInherited from
syncStatusSyncStatusAbstractStreamingSyncImplementation.syncStatus
triggerCrudUpload() => voidAbstractStreamingSyncImplementation.triggerCrudUpload

Accessors

isConnected

get isConnected(): boolean

Returns

boolean


lastSyncedAt

get lastSyncedAt(): undefined | Date

Returns

undefined | Date


webOptions

get webOptions(): WebStreamingSyncImplementationOptions

Returns

WebStreamingSyncImplementationOptions

Methods

connect()

connect(options?): Promise<void>

Connects to the sync service

Parameters

ParameterType
options?PowerSyncConnectionOptions

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.connect


disconnect()

disconnect(): Promise<void>

Disconnects from the sync services.

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.disconnect

Throws

if not connected or if abort is not controlled internally


dispose()

dispose(): Promise<void>

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.dispose


getWriteCheckpoint()

getWriteCheckpoint(): Promise<string>

Returns

Promise<string>

Inherited from

AbstractStreamingSyncImplementation.getWriteCheckpoint


hasCompletedSync()

hasCompletedSync(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

AbstractStreamingSyncImplementation.hasCompletedSync


iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

ParameterType
cb(listener) => Promise<any>

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.iterateAsyncListeners


iterateListeners()

iterateListeners(cb): void

Parameters

ParameterType
cb(listener) => any

Returns

void

Inherited from

AbstractStreamingSyncImplementation.iterateListeners


obtainLock()

obtainLock<T>(lockOptions): Promise<T>

Type parameters

Type parameter
T

Parameters

ParameterType
lockOptionsLockOptions<T>

Returns

Promise<T>

Overrides

AbstractStreamingSyncImplementation.obtainLock


registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

ParameterType
listenerPartial<StreamingSyncImplementationListener>

Returns

Function

Returns

void

Inherited from

AbstractStreamingSyncImplementation.registerListener


streamingSync()

streamingSync(signal?, options?): Promise<void>

Parameters

ParameterType
signal?AbortSignal
options?PowerSyncConnectionOptions

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.streamingSync

Deprecated

use [connect instead]


waitForReady()

waitForReady(): Promise<void>

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.waitForReady


waitForStatus()

waitForStatus(status): Promise<void>

Parameters

ParameterType
statusSyncStatusOptions

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.waitForStatus