cleanup

Author: stevensJourney

packages/common/src/client/watched/WatchedQuery.ts

@@ -83,7 +83,7 @@ export interface WatchedQueryListener extends BaseListener {
   subscriptionsChanged: (counts: SubscriptionCounts) => void;
 }
 
-export interface WatchedQuery<Data, Settings extends WatchedQueryOptions<Data> = WatchedQueryOptions<Data>>
+export interface WatchedQuery<Data = unknown, Settings extends WatchedQueryOptions<Data> = WatchedQueryOptions<Data>>
   extends BaseObserverInterface<WatchedQueryListener> {
   /**
    * Current state of the watched query.

packages/common/src/client/watched/WatchedQueryBuilder.ts

@@ -8,5 +8,5 @@ export enum IncrementalWatchMode {
  * Builds a {@link WatchedQuery} instance given a set of options.
  */
 export interface WatchedQueryBuilder {
-  build<DataType>(options: {}): WatchedQuery<DataType>;
+  build(options: {}): WatchedQuery;
 }

packages/common/src/client/watched/processors/comparators.ts

@@ -2,7 +2,13 @@ export interface WatchedQueryComparator<Data> {
   checkEquality: (current: Data, previous: Data) => boolean;
 }
 
+/**
+ * Options for {@link ArrayComparator}
+ */
 export type ArrayComparatorOptions<ItemType> = {
+  /**
+   * Returns a string to uniquely identify an item in the array.
+   */
   compareBy: (item: ItemType) => string;
 };
 

packages/react/README.md

@@ -374,6 +374,7 @@ function MyWidget() {
   const { data, isLoading } = useQuery(`SELECT * FROM cats WHERE breed = 'tabby'`, [], {
     comparator: new ArrayComparator({
       compareBy: (cat) => JSON.stringify(cat)
+    },
     reportFetching: false
   })