feat(useQuery): enable the throwOnError option of useQuery.refetch (TanStack#907)

* feat(useQuery): allow useQuery.refetch to throw an error when the fetch fails

Enables the `throwOnError` configuration option for `useQuery.refetch` that has
as of yet only been present in the documentation but not in the code.

Relates to: TanStack#903 TanStack#843

* refactor(useQuery): move "useQuery.refetch" options to dedicated type

Author: Garbanas

src/core/query.ts

@@ -58,6 +58,10 @@ export interface FetchMoreOptions {
   previous: boolean
 }
 
+export interface RefetchOptions {
+  throwOnError?: boolean;
+}
+
 export enum ActionType {
   Failed = 'Failed',
   MarkStale = 'MarkStale',
@@ -224,12 +228,16 @@ export class Query<TResult, TError> {
     )
   }
 
-  async refetch(): Promise<void> {
+  async refetch(options?: RefetchOptions): Promise<TResult | undefined> {
     try {
-      await this.fetch()
+      return await this.fetch()
     } catch (error) {
+      if (options?.throwOnError === true) {
+        throw error;
+      }
       Console.error(error)
     }
+    return;
   }
 
   heal(): void {

src/core/queryObserver.ts

@@ -1,6 +1,6 @@
 import { getStatusProps, isServer, isDocumentVisible, Console } from './utils'
 import type { QueryResult, QueryObserverConfig } from './types'
-import type { Query, QueryState, Action, FetchMoreOptions } from './query'
+import type { Query, QueryState, Action, FetchMoreOptions, RefetchOptions } from './query'
 
 export type UpdateListener<TResult, TError> = (
   result: QueryResult<TResult, TError>
@@ -86,9 +86,9 @@ export class QueryObserver<TResult, TError> {
     return this.currentQuery.clear()
   }
 
-  async refetch(): Promise<void> {
+  async refetch(options?: RefetchOptions): Promise<TResult | undefined> {
     this.currentQuery.updateConfig(this.config)
-    return this.currentQuery.refetch()
+    return this.currentQuery.refetch(options)
   }
 
   async fetchMore(

src/core/types.ts

@@ -1,4 +1,4 @@
-import type { Query, FetchMoreOptions } from './query'
+import type { Query, FetchMoreOptions, RefetchOptions } from './query';
 import type { QueryCache } from './queryCache'
 
 export type QueryKey =
@@ -165,7 +165,7 @@ export interface QueryResultBase<TResult, TError = unknown> {
   isStale: boolean
   isSuccess: boolean
   query: Query<TResult, TError>
-  refetch: () => Promise<void>
+  refetch: (options?: RefetchOptions) => Promise<TResult | undefined>
   status: QueryStatus
   updatedAt: number
 }