abstract AbstractStreamingSyncImplementation

Extends

• BaseObserver<StreamingSyncImplementationListener>

Extended by

• WebStreamingSyncImplementation

Implements

• StreamingSyncImplementation

Constructors

new AbstractStreamingSyncImplementation()

new AbstractStreamingSyncImplementation(options): AbstractStreamingSyncImplementation

Parameters

Parameter	Type
options	AbstractStreamingSyncImplementationOptions

Returns

AbstractStreamingSyncImplementation

Overrides

BaseObserver.constructor

Properties

Property	Type
syncStatus	SyncStatus
triggerCrudUpload	() => void

Accessors

isConnected

get isConnected(): boolean

Returns

boolean

---

lastSyncedAt

get lastSyncedAt(): undefined | Date

Returns

undefined | Date

Methods

connect()

connect(options?): Promise<void>

Connects to the sync service

Parameters

Parameter	Type
options?	PowerSyncConnectionOptions

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.connect

---

disconnect()

disconnect(): Promise<void>

Disconnects from the sync services.

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.disconnect

Throws

if not connected or if abort is not controlled internally

---

dispose()

dispose(): Promise<void>

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.dispose

---

getWriteCheckpoint()

getWriteCheckpoint(): Promise<string>

Returns

Promise<string>

Implementation of

StreamingSyncImplementation.getWriteCheckpoint

---

hasCompletedSync()

hasCompletedSync(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

StreamingSyncImplementation.hasCompletedSync

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

Parameter	Type
cb	(listener) => Promise<any>

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.iterateAsyncListeners

Inherited from

BaseObserver.iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Implementation of

StreamingSyncImplementation.iterateListeners

Inherited from

BaseObserver.iterateListeners

---

obtainLock()

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

Type parameters

Type parameter
T

Parameters

Parameter	Type
lockOptions	LockOptions<T>

Returns

Promise<T>

---

registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

Parameter	Type
listener	Partial<StreamingSyncImplementationListener>

Returns

Function

Returns

void

Implementation of

StreamingSyncImplementation.registerListener

Inherited from

BaseObserver.registerListener

---

streamingSync()

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

Parameters

Parameter	Type
signal?	AbortSignal
options?	PowerSyncConnectionOptions

Returns

Promise<void>

Deprecated

use [connect instead]

---

waitForReady()

waitForReady(): Promise<void>

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.waitForReady

---

waitForStatus()

waitForStatus(status): Promise<void>

Parameters

Parameter	Type
status	SyncStatusOptions

Returns

Promise<void>

Implementation of

StreamingSyncImplementation.waitForStatus