WebStreamingSyncImplementation

Extends

• AbstractStreamingSyncImplementation

Extended by

• SharedWebStreamingSyncImplementation

Constructors

Constructor

new WebStreamingSyncImplementation(options): WebStreamingSyncImplementation;

Parameters

Parameter	Type
options	WebStreamingSyncImplementationOptions

Returns

WebStreamingSyncImplementation

Overrides

AbstractStreamingSyncImplementation.constructor

Properties

Property	Type	Inherited from
syncStatus	SyncStatusSnapshot	AbstractStreamingSyncImplementation.syncStatus

Accessors

isConnected

Get Signature

get isConnected(): boolean;

Returns

boolean

Inherited from

AbstractStreamingSyncImplementation.isConnected

---

lastSyncedAt

Get Signature

get lastSyncedAt(): Date | undefined;

Returns

Date | undefined

Inherited from

AbstractStreamingSyncImplementation.lastSyncedAt

---

webOptions

Get Signature

get webOptions(): WebStreamingSyncImplementationOptions;

Returns

WebStreamingSyncImplementationOptions

Methods

connect()

connect(options): Promise<void>;

Connects to the sync service

Parameters

Parameter	Type
options	ResolvedSyncOptions

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.connect

---

disconnect()

disconnect(): Promise<void>;

Disconnects from the sync services.

Returns

Promise<void>

Throws

if not connected or if abort is not controlled internally

Inherited from

AbstractStreamingSyncImplementation.disconnect

---

dispose()

dispose(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.dispose

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>;

Parameters

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

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void;

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

AbstractStreamingSyncImplementation.iterateListeners

---

markConnectionMayHaveChanged()

markConnectionMayHaveChanged(): void;

Returns

void

Inherited from

AbstractStreamingSyncImplementation.markConnectionMayHaveChanged

---

obtainLock()

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
lockOptions	LockOptions<T>

Returns

Promise<T>

Overrides

AbstractStreamingSyncImplementation.obtainLock

---

registerListener()

registerListener(listener): () => void;

Register a listener for updates to the PowerSync client.

Parameters

Parameter	Type
listener	Partial<T>

Returns

() => void

Inherited from

AbstractStreamingSyncImplementation.registerListener

---

requestCheckpoint()

requestCheckpoint(): Promise<bigint>;

Returns

Promise<bigint>

Inherited from

AbstractStreamingSyncImplementation.requestCheckpoint

---

triggerCrudUpload()

triggerCrudUpload(): void;

Returns

void

Inherited from

AbstractStreamingSyncImplementation.triggerCrudUpload

---

updateSubscriptions()

updateSubscriptions(subscriptions): void;

Parameters

Parameter	Type
subscriptions	SubscribedStream[]

Returns

void

Inherited from

AbstractStreamingSyncImplementation.updateSubscriptions

---

waitForReady()

waitForReady(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.waitForReady

---

waitUntilStatusMatches()

waitUntilStatusMatches(predicate): Promise<void>;

Parameters

Parameter	Type
predicate	(status) => boolean

Returns

Promise<void>

Inherited from

AbstractStreamingSyncImplementation.waitUntilStatusMatches