use enums

Author: stevensJourney

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -72,8 +72,12 @@ export interface PowerSyncDatabaseOptionsWithSettings extends BasePowerSyncDatab
   database: SQLOpenOptions;
 }
 
+export enum IncrementalWatchMode {
+  COMPARISON = 'comparison'
+}
+
 export interface WatchComparatorOptions<DataType> {
-  mode: 'comparison';
+  mode: IncrementalWatchMode.COMPARISON;
   comparator?: WatchedQueryComparator<DataType>;
 }
 
@@ -891,7 +895,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     const { watch, processor } = options;
 
     switch (options.processor?.mode) {
-      case 'comparison':
+      case IncrementalWatchMode.COMPARISON:
       default:
         return new OnChangeQueryProcessor({
           db: this,
@@ -936,7 +940,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
         throttleMs: options?.throttleMs ?? DEFAULT_WATCH_THROTTLE_MS
       },
       processor: options?.processor ?? {
-        mode: 'comparison',
+        mode: IncrementalWatchMode.COMPARISON,
         comparator: FalsyComparator
       }
     });

packages/react/README.md

@@ -346,7 +346,7 @@ function MyWidget() {
   // This will result in `MyWidget` re-rendering for any change to the `cats` table.
   const { data, isLoading, isFetching } = useQuery(`SELECT * FROM cats WHERE breed = 'tabby'`, [], {
     processor: {
-      mode: 'comparison',
+      mode: IncrementalWatchMode.COMPARISON,
       comparator: new ArrayComparator({
         compareBy: (cat) => JSON.stringify(cat)
       })

packages/react/src/hooks/suspense/useSuspenseQuery.ts

@@ -1,4 +1,4 @@
-import { CompilableQuery, FalsyComparator } from '@powersync/common';
+import { CompilableQuery, FalsyComparator, IncrementalWatchMode } from '@powersync/common';
 import { AdditionalOptions } from '../watched/watch-types';
 import { SuspenseQueryResult } from './SuspenseQueryResult';
 import { useSingleSuspenseQuery } from './useSingleSuspenseQuery';
@@ -37,7 +37,7 @@ export const useSuspenseQuery = <T = any>(
       return useWatchedSuspenseQuery<T>(query, parameters, {
         ...options,
         processor: options.processor ?? {
-          mode: 'comparison',
+          mode: IncrementalWatchMode.COMPARISON,
           comparator: FalsyComparator // Default comparator that always reports changed result sets
         }
       });

packages/react/src/hooks/watched/useQuery.ts

@@ -1,4 +1,4 @@
-import { FalsyComparator, type CompilableQuery } from '@powersync/common';
+import { FalsyComparator, IncrementalWatchMode, type CompilableQuery } from '@powersync/common';
 import { usePowerSync } from '../PowerSyncContext';
 import { useSingleQuery } from './useSingleQuery';
 import { useWatchedQuery } from './useWatchedQuery';
@@ -48,7 +48,7 @@ export const useQuery = <RowType = any>(
             // Maintains backwards compatibility with previous versions
             // Comparisons are opt-in by default
             // We emit new data for each table change by default.
-            mode: 'comparison',
+            mode: IncrementalWatchMode.COMPARISON,
             comparator: FalsyComparator
           }
         }

packages/vue/src/composables/useWatchedQuery.ts

@@ -1,4 +1,10 @@
-import { type CompilableQuery, FalsyComparator, ParsedQuery, parseQuery } from '@powersync/common';
+import {
+  type CompilableQuery,
+  FalsyComparator,
+  IncrementalWatchMode,
+  ParsedQuery,
+  parseQuery
+} from '@powersync/common';
 import { type MaybeRef, type Ref, ref, toValue, watchEffect } from 'vue';
 import { usePowerSync } from './powerSync';
 import { AdditionalOptions, WatchedQueryResult } from './useSingleQuery';
@@ -63,7 +69,7 @@ export const useWatchedQuery = <T = any>(
         }
       },
       processor: options.processor ?? {
-        mode: 'comparison',
+        mode: IncrementalWatchMode.COMPARISON, // Maintains backwards compatibility with previous versions
         // Defaults to no comparison if no processor is provided
         comparator: FalsyComparator
       }