SharedWebStreamingSyncImplementation
The local part of the sync implementation on the web, which talks to a sync implementation hosted in a shared worker.
Extends
Constructors
Constructor
new SharedWebStreamingSyncImplementation(options): SharedWebStreamingSyncImplementation;
Parameters
| Parameter | Type |
|---|---|
options | SharedWebStreamingSyncImplementationOptions |
Returns
SharedWebStreamingSyncImplementation
Overrides
WebStreamingSyncImplementation.constructor
Properties
| Property | Type | Inherited from |
|---|---|---|
syncStatus | SyncStatusSnapshot | WebStreamingSyncImplementation.syncStatus |
Accessors
isConnected
Get Signature
get isConnected(): boolean;
Returns
boolean
Inherited from
WebStreamingSyncImplementation.isConnected
lastSyncedAt
Get Signature
get lastSyncedAt(): Date | undefined;
Returns
Date | undefined
Inherited from
WebStreamingSyncImplementation.lastSyncedAt
webOptions
Get Signature
get webOptions(): WebStreamingSyncImplementationOptions;
Returns
WebStreamingSyncImplementationOptions
Inherited from
WebStreamingSyncImplementation.webOptions
Methods
connect()
connect(options): Promise<void>;
Starts the sync process, this effectively acts as a call to
connect if not yet connected.
Parameters
| Parameter | Type |
|---|---|
options | ResolvedSyncOptions |
Returns
Promise<void>
Overrides
WebStreamingSyncImplementation.connect
disconnect()
disconnect(): Promise<void>;
Disconnects from the sync services.
Returns
Promise<void>
Throws
if not connected or if abort is not controlled internally
Overrides
WebStreamingSyncImplementation.disconnect
dispose()
dispose(): Promise<void>;
Returns
Promise<void>
Overrides
WebStreamingSyncImplementation.dispose
getWriteCheckpoint()
getWriteCheckpoint(): Promise<string>;
Returns
Promise<string>
Overrides
WebStreamingSyncImplementation.getWriteCheckpoint
iterateAsyncListeners()
iterateAsyncListeners(cb): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => Promise<any> |
Returns
Promise<void>
Inherited from
WebStreamingSyncImplementation.iterateAsyncListeners
iterateListeners()
iterateListeners(cb): void;
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => any |
Returns
void
Inherited from
WebStreamingSyncImplementation.iterateListeners
markConnectionMayHaveChanged()
markConnectionMayHaveChanged(): void;
Returns
void
Inherited from
WebStreamingSyncImplementation.markConnectionMayHaveChanged
obtainLock()
obtainLock<T>(lockOptions): Promise<T>;
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
lockOptions | LockOptions<T> |
Returns
Promise<T>
Inherited from
WebStreamingSyncImplementation.obtainLock
registerListener()
registerListener(listener): () => void;
Register a listener for updates to the PowerSync client.
Parameters
| Parameter | Type |
|---|---|
listener | Partial<T> |
Returns
() => void
Inherited from
WebStreamingSyncImplementation.registerListener
triggerCrudUpload()
triggerCrudUpload(): void;
Returns
void
Inherited from
WebStreamingSyncImplementation.triggerCrudUpload
updateSubscriptions()
updateSubscriptions(subscriptions): void;
Parameters
| Parameter | Type |
|---|---|
subscriptions | SubscribedStream[] |
Returns
void
Overrides
WebStreamingSyncImplementation.updateSubscriptions
waitForReady()
waitForReady(): Promise<void>;
Returns
Promise<void>
Overrides
WebStreamingSyncImplementation.waitForReady
waitUntilStatusMatches()
waitUntilStatusMatches(predicate): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
predicate | (status) => boolean |
Returns
Promise<void>