fix(types): queryCache.getQueries (#688)

* fix(types): queryCache.getQueries * fix(formatting) * fix(types): queryCache parameters * fix(formatting) * fix(formatting) Co-authored-by: Jen Gettings <[email protected]>
TanStack · Jul 2, 2020 · 04a1346 · 04a1346
1 parent 989c4cd
commit 04a1346
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 16 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -540,6 +540,12 @@ export interface CachedQuery<T, TError = unknown> {
 
 export type QueryKey<TKey> = TKey | false | null | undefined
 
+export type QueryKeyOrPredicateFn =
+  | AnyQueryKey
+  | string
+  | boolean
+  | ((query: CachedQuery<unknown>) => boolean)
+
 export interface QueryCache {
   prefetchQuery<TResult, TKey extends AnyQueryKey, TError = Error>(
     queryKey: QueryKey<TKey>,
@@ -580,20 +586,17 @@ export interface QueryCache {
     prefetch?: PrefetchQueryOptions
   }): Promise<TResult>
 
-  getQueryData<T = unknown>(key: AnyQueryKey | string): T | undefined
+  getQueryData<T = unknown>(key: QueryKeyOrPredicateFn): T | undefined
   setQueryData<TResult, TError = Error>(
-    key: AnyQueryKey | string,
+    queryKeyOrPredicateFn: QueryKeyOrPredicateFn,
     dataOrUpdater:
       | TResult
       | undefined
       | ((oldData: TResult | undefined) => TResult | undefined),
     config?: SetQueryDataQueryOptions<TResult, TError>
   ): void
   invalidateQueries<TResult>(
-    queryKeyOrPredicateFn:
-      | AnyQueryKey
-      | string
-      | ((query: CachedQuery<unknown>) => boolean),
+    queryKeyOrPredicateFn: QueryKeyOrPredicateFn,
     {
       exact,
       throwOnError,
@@ -607,19 +610,16 @@ export interface QueryCache {
     }
   ): Promise<TResult>
   removeQueries(
-    queryKeyOrPredicateFn:
-      | AnyQueryKey
-      | string
-      | ((query: CachedQuery<unknown>) => boolean),
+    queryKeyOrPredicateFn: QueryKeyOrPredicateFn,
     { exact }?: { exact?: boolean }
   ): void
-  getQuery(queryKey: AnyQueryKey): CachedQuery<unknown> | undefined
-  getQueries(queryKey: AnyQueryKey): Array<CachedQuery<unknown>>
+  getQuery(queryKeyOrPredicateFn: QueryKeyOrPredicateFn): CachedQuery<unknown> | undefined
+  getQueries(
+    queryKeyOrPredicateFn: QueryKeyOrPredicateFn,
+    { exact }?: { exact?: boolean }
+  ): Array<CachedQuery<unknown>>
   cancelQueries(
-    queryKeyOrPredicateFn:
-      | AnyQueryKey
-      | string
-      | ((query: CachedQuery<unknown>) => boolean),
+    queryKeyOrPredicateFn: QueryKeyOrPredicateFn,
     { exact }?: { exact?: boolean }
   ): void
   isFetching: number

diff --git a/types/test.ts b/types/test.ts
@@ -37,6 +37,34 @@ function prefetchQuery() {
   })
 }
 
+function getQueryData() {
+  queryCache.getQueryData(['queryKey']);
+  queryCache.getQueryData('queryKey');
+  queryCache.getQueryData(true);
+  queryCache.getQueryData((query) => true);
+}
+
+function setQueryData() {
+  queryCache.setQueryData(['queryKey'], ['data']);
+  queryCache.setQueryData('queryKey', ['data']);
+  queryCache.setQueryData(true, ['data']);
+  queryCache.setQueryData((query) => true, ['data']);
+}
+
+function getQuery() {
+  queryCache.getQuery(['queryKey']);
+  queryCache.getQuery('queryKey');
+  queryCache.getQuery(true);
+  queryCache.getQuery((query) => true);
+}
+
+function getQueries() {
+  queryCache.getQueries(['queryKey']);
+  queryCache.getQueries('queryKey');
+  queryCache.getQueries(true);
+  queryCache.getQueries((query) => true);
+}
+
 function simpleQuery() {
   // Query - simple case
   const querySimple = useQuery<string, 'todos'>('todos', () =>