@tanstack/react-query 5.0.0-alpha.21 → 5.0.0-alpha.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/react-query",
-  "version": "5.0.0-alpha.21",
+  "version": "5.0.0-alpha.23",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in React",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "react-error-boundary": "^3.1.4"
   },
   "dependencies": {
-    "@tanstack/query-core": "5.0.0-alpha.21"
+    "@tanstack/query-core": "5.0.0-alpha.23"
   },
   "peerDependencies": {
     "react": "^18.0.0",

package/src/__tests__/QueryResetErrorBoundary.test.tsx

@@ -38,7 +38,7 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
         })
         return <div>{data}</div>
       }
@@ -97,7 +97,7 @@ describe('QueryErrorResetBoundary', () => {
           },
           retry: false,
           enabled: !succeed,
-          throwErrors: true,
+          throwOnError: true,
         })
         return (
           <div>
@@ -163,7 +163,7 @@ describe('QueryErrorResetBoundary', () => {
           },
           retry: false,
           enabled,
-          throwErrors: true,
+          throwOnError: true,
         })
 
         React.useEffect(() => {
@@ -221,7 +221,7 @@ describe('QueryErrorResetBoundary', () => {
           },
           retry: false,
           enabled: false,
-          throwErrors: true,
+          throwOnError: true,
         })
 
         return (
@@ -289,7 +289,7 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
         })
         return <div>{data}</div>
       }
@@ -347,7 +347,7 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
           initialData: 'initial',
         })
         return <div>{data}</div>
@@ -408,7 +408,7 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
         })
         return <div>{data}</div>
       }
@@ -471,7 +471,7 @@ describe('QueryErrorResetBoundary', () => {
             throw new Error('Error')
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
         })
         return <div>{data}</div>
       }
@@ -624,7 +624,7 @@ describe('QueryErrorResetBoundary', () => {
             }
           },
           retry: false,
-          throwErrors: true,
+          throwOnError: true,
         })
         return <div>{data}</div>
       }
@@ -685,7 +685,7 @@ describe('QueryErrorResetBoundary', () => {
                 }
               },
               retry: false,
-              throwErrors: true,
+              throwOnError: true,
               retryOnMount: true,
             },
           ],
@@ -748,7 +748,7 @@ describe('QueryErrorResetBoundary', () => {
                 }
               },
               retry: false,
-              throwErrors: true,
+              throwOnError: true,
               retryOnMount: true,
               suspense: true,
             },

package/src/__tests__/suspense.test.tsx

@@ -534,7 +534,7 @@ describe("useQuery's in Suspense mode", () => {
     consoleMock.mockRestore()
   })
 
-  it('should not throw errors to the error boundary when throwErrors: false', async () => {
+  it('should not throw errors to the error boundary when throwOnError: false', async () => {
     const key = queryKey()
 
     function Page() {
@@ -546,7 +546,7 @@ describe("useQuery's in Suspense mode", () => {
         },
         retry: false,
         suspense: true,
-        throwErrors: false,
+        throwOnError: false,
       })
       return <div>rendered</div>
     }
@@ -573,7 +573,7 @@ describe("useQuery's in Suspense mode", () => {
     await waitFor(() => rendered.getByText('rendered'))
   })
 
-  it('should throw errors to the error boundary when a throwErrors function returns true', async () => {
+  it('should throw errors to the error boundary when a throwOnError function returns true', async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -588,7 +588,7 @@ describe("useQuery's in Suspense mode", () => {
         },
         retry: false,
         suspense: true,
-        throwErrors: (err) => err.message !== 'Local Error',
+        throwOnError: (err) => err.message !== 'Local Error',
       })
       return <div>rendered</div>
     }
@@ -616,7 +616,7 @@ describe("useQuery's in Suspense mode", () => {
     consoleMock.mockRestore()
   })
 
-  it('should not throw errors to the error boundary when a throwErrors function returns false', async () => {
+  it('should not throw errors to the error boundary when a throwOnError function returns false', async () => {
     const key = queryKey()
 
     function Page() {
@@ -628,7 +628,7 @@ describe("useQuery's in Suspense mode", () => {
         },
         retry: false,
         suspense: true,
-        throwErrors: (err) => err.message !== 'Local Error',
+        throwOnError: (err) => err.message !== 'Local Error',
       })
       return <div>rendered</div>
     }

package/src/__tests__/useMutation.test.tsx

@@ -688,7 +688,7 @@ describe('useMutation', () => {
     fireEvent.click(getByText('unmount'))
   })
 
-  it('should be able to throw an error when throwErrors is set to true', async () => {
+  it('should be able to throw an error when throwOnError is set to true', async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -699,7 +699,7 @@ describe('useMutation', () => {
           err.stack = ''
           return Promise.reject(err)
         },
-        throwErrors: true,
+        throwOnError: true,
       })
 
       return (
@@ -735,7 +735,7 @@ describe('useMutation', () => {
     consoleMock.mockRestore()
   })
 
-  it('should be able to throw an error when throwErrors is a function that returns true', async () => {
+  it('should be able to throw an error when throwOnError is a function that returns true', async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -747,7 +747,7 @@ describe('useMutation', () => {
           err.stack = ''
           return Promise.reject(err)
         },
-        throwErrors: () => {
+        throwOnError: () => {
           boundary = !boundary
           return !boundary
         },

package/src/__tests__/useQueries.test.tsx

@@ -644,7 +644,7 @@ describe('useQueries', () => {
     }
   })
 
-  it("should throw error if in one of queries' queryFn throws and throwErrors is in use", async () => {
+  it("should throw error if in one of queries' queryFn throws and throwOnError is in use", async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -661,14 +661,14 @@ describe('useQueries', () => {
             queryFn: () =>
               Promise.reject(
                 new Error(
-                  'this should not throw because throwErrors is not set',
+                  'this should not throw because throwOnError is not set',
                 ),
               ),
           },
           {
             queryKey: key2,
             queryFn: () => Promise.reject(new Error('single query error')),
-            throwErrors: true,
+            throwOnError: true,
             retry: false,
           },
           {
@@ -681,7 +681,7 @@ describe('useQueries', () => {
               Promise.reject(
                 new Error('this should not throw because query#2 already did'),
               ),
-            throwErrors: true,
+            throwOnError: true,
             retry: false,
           },
         ],
@@ -709,7 +709,7 @@ describe('useQueries', () => {
     consoleMock.mockRestore()
   })
 
-  it("should throw error if in one of queries' queryFn throws and throwErrors function resolves to true", async () => {
+  it("should throw error if in one of queries' queryFn throws and throwOnError function resolves to true", async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -726,10 +726,10 @@ describe('useQueries', () => {
             queryFn: () =>
               Promise.reject(
                 new Error(
-                  'this should not throw because throwErrors function resolves to false',
+                  'this should not throw because throwOnError function resolves to false',
                 ),
               ),
-            throwErrors: () => false,
+            throwOnError: () => false,
             retry: false,
           },
           {
@@ -739,7 +739,7 @@ describe('useQueries', () => {
           {
             queryKey: key3,
             queryFn: () => Promise.reject(new Error('single query error')),
-            throwErrors: () => true,
+            throwOnError: () => true,
             retry: false,
           },
           {
@@ -748,7 +748,7 @@ describe('useQueries', () => {
               Promise.reject(
                 new Error('this should not throw because query#3 already did'),
               ),
-            throwErrors: true,
+            throwOnError: true,
             retry: false,
           },
         ],

package/src/__tests__/useQuery.test.tsx

@@ -2747,7 +2747,7 @@ describe('useQuery', () => {
     await waitFor(() => rendered.getByText('Error test jaylen'))
   })
 
-  it('should throw error if queryFn throws and throwErrors is in use', async () => {
+  it('should throw error if queryFn throws and throwOnError is in use', async () => {
     const consoleMock = vi
       .spyOn(console, 'error')
       .mockImplementation(() => undefined)
@@ -2758,7 +2758,7 @@ describe('useQuery', () => {
         queryKey: key,
         queryFn: () => Promise.reject(new Error('Error test jaylen')),
         retry: false,
-        throwErrors: true,
+        throwOnError: true,
       })
 
       return (
@@ -2780,7 +2780,7 @@ describe('useQuery', () => {
     consoleMock.mockRestore()
   })
 
-  it('should update with data if we observe no properties and throwErrors', async () => {
+  it('should update with data if we observe no properties and throwOnError', async () => {
     const key = queryKey()
 
     let result: UseQueryResult<string> | undefined
@@ -2789,7 +2789,7 @@ describe('useQuery', () => {
       const query = useQuery({
         queryKey: key,
         queryFn: () => Promise.resolve('data'),
-        throwErrors: true,
+        throwOnError: true,
       })
 
       React.useEffect(() => {
@@ -2817,7 +2817,7 @@ describe('useQuery', () => {
         queryFn: () => Promise.reject(new Error('Local Error')),
 
         retry: false,
-        throwErrors: (err) => err.message !== 'Local Error',
+        throwOnError: (err) => err.message !== 'Local Error',
       })
 
       return (
@@ -2852,7 +2852,7 @@ describe('useQuery', () => {
         queryFn: () => Promise.reject(new Error('Remote Error')),
 
         retry: false,
-        throwErrors: (err) => err.message !== 'Local Error',
+        throwOnError: (err) => err.message !== 'Local Error',
       })
 
       return (

package/src/errorBoundaryUtils.ts

@@ -4,7 +4,7 @@ import type {
   Query,
   QueryKey,
   QueryObserverResult,
-  ThrowErrors,
+  ThrowOnError,
 } from '@tanstack/query-core'
 import type { QueryErrorResetBoundaryValue } from './QueryErrorResetBoundary'
 import * as React from 'react'
@@ -26,7 +26,7 @@ export const ensurePreventErrorBoundaryRetry = <
   >,
   errorResetBoundary: QueryErrorResetBoundaryValue,
 ) => {
-  if (options.suspense || options.throwErrors) {
+  if (options.suspense || options.throwOnError) {
     // Prevent retrying failed query if the error boundary has not been reset yet
     if (!errorResetBoundary.isReset()) {
       options.retryOnMount = false
@@ -51,18 +51,18 @@ export const getHasError = <
 >({
   result,
   errorResetBoundary,
-  throwErrors,
+  throwOnError,
   query,
 }: {
   result: QueryObserverResult<TData, TError>
   errorResetBoundary: QueryErrorResetBoundaryValue
-  throwErrors: ThrowErrors<TQueryFnData, TError, TQueryData, TQueryKey>
+  throwOnError: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>
   query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
 }) => {
   return (
     result.isError &&
     !errorResetBoundary.isReset() &&
     !result.isFetching &&
-    shouldThrowError(throwErrors, [result.error, query])
+    shouldThrowError(throwOnError, [result.error, query])
   )
 }

package/src/useBaseQuery.ts

@@ -84,7 +84,7 @@ export function useBaseQuery<
     getHasError({
       result,
       errorResetBoundary,
-      throwErrors: defaultedOptions.throwErrors,
+      throwOnError: defaultedOptions.throwOnError,
       query: observer.getCurrentQuery(),
     })
   ) {

package/src/useMutation.ts

@@ -56,7 +56,7 @@ export function useMutation<
 
   if (
     result.error &&
-    shouldThrowError(observer.options.throwErrors, [result.error])
+    shouldThrowError(observer.options.throwOnError, [result.error])
   ) {
     throw result.error
   }

package/src/useQueries.ts

@@ -243,7 +243,7 @@ export function useQueries<T extends any[]>(
       getHasError({
         result,
         errorResetBoundary,
-        throwErrors: defaultedQueries[index]?.throwErrors ?? false,
+        throwOnError: defaultedQueries[index]?.throwOnError ?? false,
         query: observerQueries[index]!,
       }),
   )