SyncSubscriptionDescription
Information about a subscribed sync stream.
This includes the SyncStreamDescription, along with information about the current sync status.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
active | boolean | - | - |
expiresAt | Date | null | For sync streams that have a time-to-live, the current time at which the stream would expire if not subscribed to again. | - |
hasExplicitSubscription | boolean | Whether this stream has been subscribed to explicitly. It's possible for both SyncSubscriptionDescription.isDefault and SyncSubscriptionDescription.hasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly. | - |
hasSynced | boolean | Whether this stream subscription has been synced at least once. | - |
isDefault | boolean | Whether this stream subscription is included by default, regardless of whether the stream has explicitly been subscribed to or not. It's possible for both SyncSubscriptionDescription.isDefault and SyncSubscriptionDescription.hasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly. | - |
lastSyncedAt | Date | null | If SyncSubscriptionDescription.hasSynced is true, the last time data from this stream has been synced. | - |
name | string | The name of the stream as it appears in the stream definition for the PowerSync service. | SyncStreamDescription.name |
parameters | Record<string, any> | null | The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters. | SyncStreamDescription.parameters |