Improve LiveQuery typings

* Don't allow fullResponse request options * Use generics to allow more refined typing of return values
orbitjs · Feb 8, 2021 · fc43302 · fc43302
1 parent 7b9e73b
commit fc43302
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/packages/@orbit/record-cache/src/async-record-cache.ts b/packages/@orbit/record-cache/src/async-record-cache.ts
@@ -325,7 +325,7 @@ export abstract class AsyncRecordCache<
 
   liveQuery(
     queryOrExpressions: RecordQueryOrExpressions,
-    options?: RequestOptions,
+    options?: DefaultRequestOptions<QueryOptions>,
     id?: string
   ): AsyncLiveQuery {
     const query = buildQuery(

diff --git a/packages/@orbit/record-cache/src/live-query/async-live-query.ts b/packages/@orbit/record-cache/src/live-query/async-live-query.ts
@@ -16,7 +16,9 @@ export class AsyncLiveQueryUpdate {
     this._query = settings.query;
   }
 
-  query(): Promise<RecordQueryResult> {
+  query<Result extends RecordQueryResult = RecordQueryResult>(): Promise<
+    Result
+  > {
     return this._cache.query(this._query);
   }
 }
@@ -44,7 +46,9 @@ export class AsyncLiveQuery extends LiveQuery {
     this.cache = settings.cache;
   }
 
-  async query(): Promise<RecordQueryResult> {
+  query<Result extends RecordQueryResult = RecordQueryResult>(): Promise<
+    Result
+  > {
     return this._update.query();
   }
 

diff --git a/packages/@orbit/record-cache/src/live-query/sync-live-query.ts b/packages/@orbit/record-cache/src/live-query/sync-live-query.ts
@@ -16,7 +16,7 @@ export class SyncLiveQueryUpdate {
     this._query = settings.query;
   }
 
-  query(): RecordQueryResult {
+  query<Result extends RecordQueryResult = RecordQueryResult>(): Result {
     return this._cache.query(this._query);
   }
 }
@@ -44,8 +44,8 @@ export class SyncLiveQuery extends LiveQuery {
     this.cache = settings.cache;
   }
 
-  query(): RecordQueryResult {
-    return this._update.query();
+  query<Result extends RecordQueryResult = RecordQueryResult>(): Result {
+    return this._update.query<Result>();
   }
 
   subscribe(cb: (update: SyncLiveQueryUpdate) => void): () => void {

diff --git a/packages/@orbit/record-cache/src/sync-record-cache.ts b/packages/@orbit/record-cache/src/sync-record-cache.ts
@@ -312,7 +312,7 @@ export abstract class SyncRecordCache<
 
   liveQuery(
     queryOrExpressions: RecordQueryOrExpressions,
-    options?: RequestOptions,
+    options?: DefaultRequestOptions<QueryOptions>,
     id?: string
   ): SyncLiveQuery {
     const query = buildQuery(