Add setConsole utility

Fixes TanStack#125

Author: tannerlinsley

.size-snapshot.json

@@ -1,13 +1,13 @@
 {
   "dist/index.js": {
-    "bundled": 31436,
-    "minified": 15930,
-    "gzipped": 4571
+    "bundled": 31608,
+    "minified": 15961,
+    "gzipped": 4574
   },
   "dist/index.es.js": {
-    "bundled": 30916,
-    "minified": 15466,
-    "gzipped": 4473,
+    "bundled": 31088,
+    "minified": 15497,
+    "gzipped": 4478,
     "treeshaked": {
       "rollup": {
         "code": 3292,

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.2
+
+- Added a new `setConsole` exported function that allows you replace the `console` interface used to log errors. By default, the `window.console` object is used.
+
+## 0.4.1
+
+- Fixed an issue where interval fetching errors would throw repeatedly
+
 ## 0.4.0
 
 - Added the `useMutation.throwOnError` and corresponding `queryConfig.throwOnError` option to configure whether the `mutate` function rethrows errors encountered in the mutation function

README.md

@@ -246,6 +246,7 @@ This library is being built and maintained by me, @tannerlinsley and I am always
   - [`useIsFetching`](#useisfetching)
   - [`clearQueryCache`](#clearquerycache)
   - [`ReactQueryConfigProvider`](#reactqueryconfigprovider)
+  - [`setConsole`](#setConsole)
 
 ## Installation
 
@@ -1592,3 +1593,23 @@ function App() {
 - `config: Object`
   - Must be **stable** or **memoized**. Do not create an inline object!
   - For a description of all config options, please see their usage in both the [`useQuery` hook](#usequery) and the [`useMutation` hook](#usemutation).
+
+## `setConsole`
+
+`setConsole` is an optional utility function that allows you replace the `console` interface used to log errors. By default, the `window.console` object is used. If no global `console` object is found in the environment, nothing will be logged.
+
+```js
+import { setConsole } from 'react-query'
+import { printLog, printWarn, printError } from 'custom-logger'
+
+setConsole({
+  log: printLog,
+  warn: printWarn,
+  error: printError,
+})
+```
+
+### Options
+
+- `console: Object`
+  - Must implement the `log`, `warn`, and `error` methods.

src/index.js

@@ -6,6 +6,8 @@ export let globalStateListeners = []
 let uid = 0
 const configContext = React.createContext()
 const isServer = typeof window === 'undefined'
+const noop = () => {}
+let Console = console || { error: noop, warn: noop, log: noop }
 
 let defaultConfig = {
   retry: 3,
@@ -20,6 +22,10 @@ let defaultConfig = {
   useErrorBoundary: undefined, // this will default to the suspense value
 }
 
+export function setConsole(c) {
+  Console = c
+}
+
 const onWindowFocus = () => {
   const { refetchAllOnWindowFocus } = defaultConfig
 
@@ -33,7 +39,7 @@ const onWindowFocus = () => {
         }
       },
     }).catch(error => {
-      console.error(error.message)
+      Console.error(error.message)
     })
   }
 }
@@ -444,7 +450,7 @@ export function useQuery(queryKey, queryFn, config = {}) {
           try {
             query.fetch()
           } catch (err) {
-            console.error(err)
+            Console.error(err)
             // Swallow this error, since it is handled elsewhere
           }
         }
@@ -506,7 +512,7 @@ export function useQuery(queryKey, queryFn, config = {}) {
       try {
         await query.fetch()
       } catch (err) {
-        console.error(err)
+        Console.error(err)
         // Swallow this error. Don't rethrow it into a render function
       }
     }
@@ -580,7 +586,7 @@ export async function prefetchQuery(queryKey, queryFn, config = {}) {
   // Trigger a query subscription with one-time unique id
   const unsubscribeFromQuery = query.subscribe({
     id: uid++,
-    onStateUpdate: () => {},
+    onStateUpdate: noop,
   })
 
   // Trigger a fetch and return the promise
@@ -667,7 +673,7 @@ export function useMutation(
           try {
             await doRefetchQueries()
           } catch (err) {
-            console.error(err)
+            Console.error(err)
             // Swallow this error since it is a side-effect
           }
         }
@@ -791,7 +797,7 @@ function defaultQueryKeySerializerFn(queryKey) {
     const variablesIsObject = isObject(variables)
 
     if (typeof id !== 'string' || (variables && !variablesIsObject)) {
-      console.warn('Tuple queryKey:', queryKey)
+      Console.warn('Tuple queryKey:', queryKey)
       throw new Error(
         `Invalid query key tuple type: [${typeof id}, and ${typeof variables}]`
       )