fix(useQuery): pass query as second parameter to useErrorBoundary function(TanStack#2660)

Author: TkDodo

docs/src/pages/reference/useQuery.md

@@ -175,11 +175,11 @@ const result = useQuery({
   - Optional
   - Defaults to `true`
   - If set to `false`, structural sharing between query results will be disabled.
-- `useErrorBoundary: undefined | boolean | (error: TError) => boolean`
+- `useErrorBoundary: undefined | boolean | (error: TError, query: Query) => boolean`
   - Defaults to the global query config's `useErrorBoundary` value, which is `undefined`
   - Set this to `true` if you want errors to be thrown in the render phase and propagate to the nearest error boundary
   - Set this to `false` to disable `suspense`'s default behavior of throwing errors to the error boundary.
-  - If set to a function, it will be passed the error and should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`)
+  - If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`)
 - `meta: Record<string, unknown>`
   - Optional
   - If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

src/core/types.ts

@@ -183,10 +183,15 @@ export interface QueryObserverOptions<
    * Whether errors should be thrown instead of setting the `error` property.
    * If set to `true` or `suspense` is `true`, all errors will be thrown to the error boundary.
    * If set to `false` and `suspense` is `false`, errors are returned as state.
-   * If set to a function, it will be passed the error and should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`).
+   * If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (`true`) or return the error as state (`false`).
    * Defaults to `false`.
    */
-  useErrorBoundary?: boolean | ((error: TError) => boolean)
+  useErrorBoundary?:
+    | boolean
+    | ((
+        error: TError,
+        query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
+      ) => boolean)
   /**
    * This option can be used to transform or select a part of the data returned by the query function.
    */

src/react/useBaseQuery.ts

@@ -136,7 +136,7 @@ export function useBaseQuery<
     shouldThrowError(
       defaultedOptions.suspense,
       defaultedOptions.useErrorBoundary,
-      result.error
+      [result.error, observer.getCurrentQuery()]
     )
   ) {
     throw result.error

src/react/useMutation.ts

@@ -80,7 +80,9 @@ export function useMutation<
   const options = parseMutationArgs(arg1, arg2, arg3)
   const queryClient = useQueryClient()
 
-  const obsRef = React.useRef<MutationObserver<any, any, any, any>>()
+  const obsRef = React.useRef<
+    MutationObserver<TData, TError, TVariables, TContext>
+  >()
 
   if (!obsRef.current) {
     obsRef.current = new MutationObserver(queryClient, options)
@@ -114,11 +116,9 @@ export function useMutation<
 
   if (
     currentResult.error &&
-    shouldThrowError(
-      undefined,
-      obsRef.current.options.useErrorBoundary,
-      currentResult.error
-    )
+    shouldThrowError(undefined, obsRef.current.options.useErrorBoundary, [
+      currentResult.error,
+    ])
   ) {
     throw currentResult.error
   }

src/react/utils.ts

@@ -1,11 +1,11 @@
-export function shouldThrowError<TError>(
+export function shouldThrowError<T extends (...args: any[]) => boolean>(
   suspense: boolean | undefined,
-  _useErrorBoundary: boolean | ((err: TError) => boolean) | undefined,
-  error: TError
+  _useErrorBoundary: boolean | T | undefined,
+  params: Parameters<T>
 ): boolean {
   // Allow useErrorBoundary function to override throwing behavior on a per-error basis
   if (typeof _useErrorBoundary === 'function') {
-    return _useErrorBoundary(error)
+    return _useErrorBoundary(...params)
   }
 
   // Allow useErrorBoundary to override suspense's throwing behavior