Resolve TODOs

Author: benitav

packages/powersync-sdk-common/src/client/AbstractPowerSyncDatabase.ts

@@ -46,6 +46,7 @@ export interface PowerSyncDatabaseOptions {
 export interface SQLWatchOptions {
   signal?: AbortSignal;
   tables?: string[];
+  /** The minimum interval between queries. */
   throttleMs?: number;
   /**
    * Allows for watching any SQL table
@@ -533,8 +534,8 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
 
   /**
    * Execute a read query every time the source tables are modified.
-   * TODO: Use throttle to specify the minimum interval between queries.
-   * TODO: Source tables are automatically detected using `EXPLAIN QUERY PLAN`.
+   * Use {@link SQLWatchOptions.throttleMs} to specify the minimum interval between queries.
+   * Source tables are automatically detected using `EXPLAIN QUERY PLAN`.
    */
   async *watch(sql: string, parameters?: any[], options?: SQLWatchOptions): AsyncIterable<QueryResult> {
     //Fetch initial data
@@ -622,9 +623,6 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     });
   }
 
-  /**
-   * TODO
-   */
   private async executeReadOnly(sql: string, params: any[]) {
     await this.waitForReady();
     return this.database.readLock((tx) => tx.execute(sql, params));

packages/powersync-sdk-common/src/client/sync/bucket/CrudTransaction.ts

@@ -1,9 +1,6 @@
 import { CrudBatch } from './CrudBatch';
 import { CrudEntry } from './CrudEntry';
 
-/**
- * TODO
- */
 export class CrudTransaction extends CrudBatch {
   constructor(
     /**

packages/powersync-sdk-common/src/db/crud/SyncStatus.ts

@@ -30,12 +30,19 @@ export class SyncStatus {
   }
 
   /**
-   * TODO
+   *  Upload/download status
    */
   get dataFlowStatus() {
     return (
       this.options.dataFlow ?? {
+        /**
+         * true if actively downloading changes.
+         * This is only true when {@link connected} is also true.
+         */
         downloading: false,
+        /**
+         * true if uploading changes.
+         */
         uploading: false
       }
     );