fix: queryKeySerializer now in the right spot of the config

TanStack · Jun 24, 2020 · a68dc28 · a68dc28
1 parent ef5becb
commit a68dc28
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -207,7 +207,6 @@ This library is being built and maintained by me, @tannerlinsley and I am always
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Installation](#installation)
 - [Defaults to keep in mind](#defaults-to-keep-in-mind)
 - [Quick Start](#quick-start)
@@ -2323,10 +2322,10 @@ import { ReactQueryConfigProvider } from 'react-query'
 const queryConfig = {
   shared: {
     suspense: false,
-    queryKeySerializerFn: defaultQueryKeySerializerFn,
   },
   queries: {
-    ...shared,
+    suspense, // defaults to `shared.suspense`
+    queryKeySerializerFn: defaultQueryKeySerializerFn,
     queryFn,
     enabled: true,
     retry: 3,
@@ -2344,7 +2343,7 @@ const queryConfig = {
     useErrorBoundary: false, // falls back to suspense
   },
   mutations: {
-    ...shared,
+    suspense, // defaults to `shared.suspense`
     throwOnError: false,
     onMutate: noop,
     onError: noop,

diff --git a/src/config.js b/src/config.js
@@ -6,9 +6,9 @@ export const configContext = React.createContext()
 const DEFAULT_CONFIG = {
   shared: {
     suspense: false,
-    queryKeySerializerFn: defaultQueryKeySerializerFn,
   },
   queries: {
+    queryKeySerializerFn: defaultQueryKeySerializerFn,
     queryFn: undefined,
     enabled: true,
     retry: 3,

diff --git a/src/queryCache.js b/src/queryCache.js
@@ -108,7 +108,7 @@ export function makeQueryCache({ frozen = isServer, defaultConfig } = {}) {
       const [
         queryHash,
         queryKey,
-      ] = configRef.current.shared.queryKeySerializerFn(predicate)
+      ] = configRef.current.queries.queryKeySerializerFn(predicate)
 
       predicate = d =>
         exact ? d.queryHash === queryHash : deepIncludes(d.queryKey, queryKey)

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -305,14 +305,6 @@ export type InfiniteQueryFunction<
 
 export interface BaseSharedOptions {
   suspense: boolean
-  queryKeySerializerFn?: (
-    queryKey:
-      | QueryKeyPart[]
-      | string
-      | false
-      | undefined
-      | (() => QueryKeyPart[] | string | false | undefined)
-  ) => [string, QueryKeyPart[]] | []
 }
 
 export interface BaseQueryOptions<TError = Error> {
@@ -357,7 +349,8 @@ export interface PrefetchQueryOptions<TResult, TError = Error>
   throwOnError?: boolean
 }
 
-export interface SetQueryDataQueryOptions<TResult, TError = Error> extends QueryOptions<TResult, TError> {
+export interface SetQueryDataQueryOptions<TResult, TError = Error>
+  extends QueryOptions<TResult, TError> {
   exact?: boolean
 }
 
@@ -475,7 +468,7 @@ export function useMutation<TResults, TVariables = undefined, TError = Error>(
 
 export type MutationFunction<TResults, TVariables, TError = Error> = (
   variables: TVariables,
-  mutateOptions?: MutateOptions<TResults, TVariables, TError>,
+  mutateOptions?: MutateOptions<TResults, TVariables, TError>
 ) => Promise<TResults>
 
 export interface MutateOptions<TResult, TVariables, TError = Error> {
@@ -504,7 +497,10 @@ export type MutateFunction<
   TError = Error
 > = undefined extends TVariables
   ? (options?: MutateOptions<TResult, TVariables, TError>) => Promise<TResult>
-  : (variables: TVariables, options?: MutateOptions<TResult, TVariables, TError>) => Promise<TResult>
+  : (
+      variables: TVariables,
+      options?: MutateOptions<TResult, TVariables, TError>
+    ) => Promise<TResult>
 
 export interface MutationResultBase<TResult, TError = Error> {
   status: 'idle' | 'loading' | 'error' | 'success'
@@ -637,7 +633,10 @@ export interface QueryCache {
   getQueryData<T = unknown>(key: AnyQueryKey | string): T | undefined
   setQueryData<TResult, TError>(
     key: AnyQueryKey | string,
-    dataOrUpdater: TResult | undefined | ((oldData: TResult | undefined) => TResult | undefined),
+    dataOrUpdater:
+      | TResult
+      | undefined
+      | ((oldData: TResult | undefined) => TResult | undefined),
     config?: SetQueryDataQueryOptions<TResult, TError>
   ): void
   invalidateQueries<TResult>(
@@ -712,6 +711,14 @@ export interface ReactQueryProviderConfig<TError = Error> {
     /** Defaults to the value of `suspense` if not defined otherwise */
     useErrorBoundary?: boolean
     refetchOnWindowFocus?: boolean
+    queryKeySerializerFn?: (
+      queryKey:
+        | QueryKeyPart[]
+        | string
+        | false
+        | undefined
+        | (() => QueryKeyPart[] | string | false | undefined)
+    ) => [string, QueryKeyPart[]] | []
   }
   shared?: BaseSharedOptions
   mutations?: {