More JSDoc comments

Author: benitav

packages/powersync-react/src/hooks/usePowerSyncQuery.ts

@@ -3,7 +3,7 @@ import { usePowerSync } from './PowerSyncContext';
 
 /**
  * A hook to access a single static query.
- * For an updated result, use usePowerSyncWatchedQuery instead
+ * For an updated result, use {@link usePowerSyncWatchedQuery} instead
  */
 export const usePowerSyncQuery = <T = any>(sqlStatement: string, parameters: any[] = []): T[] => {
   const powerSync = usePowerSync();

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

@@ -21,10 +21,12 @@ import { EventIterator } from 'event-iterator';
 import { quoteIdentifier } from '../utils/strings';
 
 export interface DisconnectAndClearOptions {
+  /** When set to false, data in local-only tables is preserved. */
   clearLocal?: boolean;
 }
 
 export interface PowerSyncDatabaseOptions {
+  /** Schema used for the local database. */
   schema: Schema;
   database: DBAdapter;
   /**
@@ -436,15 +438,15 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
   }
 
   /**
-   * Execute a statement and optionally return results
+   * Execute a statement and optionally return results.
    */
   async execute(sql: string, parameters?: any[]) {
     await this.waitForReady();
     return this.database.execute(sql, parameters);
   }
 
   /**
-   *  Execute a read-only query and return results
+   *  Execute a read-only query and return results.
    */
   async getAll<T>(sql: string, parameters?: any[]): Promise<T[]> {
     await this.waitForReady();

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

@@ -4,6 +4,7 @@ import { Schema } from '../db/schema/Schema';
 import { AbstractPowerSyncDatabase, PowerSyncDatabaseOptions } from './AbstractPowerSyncDatabase';
 
 export interface PowerSyncOpenFactoryOptions extends Partial<PowerSyncDatabaseOptions> {
+  /** Schema used for the local database. */
   schema: Schema;
   /**
    * Filename for the database.

packages/powersync-sdk-common/src/client/connection/PowerSyncBackendConnector.ts

@@ -16,7 +16,7 @@ export interface PowerSyncBackendConnector {
 
   /** Upload local changes to the app backend.
    *
-   * Use [PowerSyncDatabase.getCrudBatch] to get a batch of changes to upload. See [DevConnector] for an example implementation.
+   * Use {@link AbstractPowerSyncDatabase.getCrudBatch} to get a batch of changes to upload. 
    *
    * Any thrown errors will result in a retry after the configured wait period (default: 5 seconds).
    */

packages/powersync-sdk-common/src/db/DBAdapter.ts

@@ -11,18 +11,14 @@ import { BaseListener, BaseObserverInterface } from '../utils/BaseObserver';
  */
 
 /**
- * Object returned by SQL Query executions {
- *  insertId: Represent the auto-generated row id if applicable
- *  rowsAffected: Number of affected rows if result of a update query
- *  message: if status === 1, here you will find error description
- *  rows: if status is undefined or 0 this object will contain the query results
- * }
- *
- * @interface QueryResult
+ * Object returned by SQL Query executions.
  */
 export type QueryResult = {
+  /** Represents the auto-generated row id if applicable. */
   insertId?: number;
+  /** Number of affected rows if result of a update query. */
   rowsAffected: number;
+  /** if status is undefined or 0 this object will contain the query results */
   rows?: {
     /** Raw array with all dataset */
     _array: any[];
@@ -37,12 +33,16 @@ export type QueryResult = {
 };
 
 export interface DBGetUtils {
+  /** Execute a read-only query and return results. */
   getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+  /** Execute a read-only query and return the first result, or null if the ResultSet is empty. */
   getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+  /** Execute a read-only query and return the first result, error if the ResultSet is empty. */
   get<T>(sql: string, parameters?: any[]): Promise<T>;
 }
 
 export interface LockContext extends DBGetUtils {
+  /** Execute a statement and optionally return results. */
   execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
 }
 
@@ -63,6 +63,10 @@ export interface TableUpdateOperation {
   opType: RowUpdateType;
   rowId: number;
 }
+
+/**
+ * Notification of an update to one or more tables, for the purpose of realtime change notifications.
+ */
 export interface UpdateNotification extends TableUpdateOperation {
   table: string;
 }