Skip to main content

SyncStreamSubscription

Extends

Properties

PropertyTypeDescriptionInherited from
namestringThe name of the stream as it appears in the stream definition for the PowerSync service.SyncStreamDescription.name
parametersRecord<string, any> | nullThe parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.SyncStreamDescription.parameters

Methods

unsubscribe()

unsubscribe(): void;

Removes this stream subscription.

Returns

void


waitForFirstSync()

waitForFirstSync(abort?): Promise<void>;

A promise that resolves once data from in this sync stream has been synced and applied.

Parameters

ParameterType
abort?AbortSignal

Returns

Promise<void>