Mark as experimental

Author: simolus3

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -544,6 +544,14 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     this.iterateListeners((l) => l.statusChanged?.(this.currentStatus));
   }
 
+  /**
+   * Create a sync stream to query its status or to subscribe to it.
+   *
+   * @param name The name of the stream to subscribe to.
+   * @param params Optional parameters for the stream subscription.
+   * @returns A {@link SyncStream} instance that can be subscribed to.
+   * @experimental Sync streams are currently in alpha.
+   */
   syncStream(name: string, params?: Record<string, any>): SyncStream {
     return this.connectionManager.stream(this.subscriptions, name, params ?? null);
   }

packages/common/src/db/crud/SyncStatus.ts

@@ -122,13 +122,17 @@ export class SyncStatus {
    *
    * This returns null when the database is currently being opened and we don't have reliable information about all
    * included streams yet.
+   *
+   * @experimental Sync streams are currently in alpha.
    */
   get syncStreams(): SyncStreamStatus[] | undefined {
     return this.options.dataFlow?.internalStreamSubscriptions?.map((core) => new SyncStreamStatusView(this, core));
   }
 
   /**
    * If the `stream` appears in {@link syncStreams}, returns the current status for that stream.
+   *
+   * @experimental Sync streams are currently in alpha.
    */
   forStream(stream: SyncStreamDescription): SyncStreamStatus | undefined {
     const asJson = JSON.stringify(stream.parameters);