feat(QueryCache): add option to alwaysRefetchOnMount

Author: GeospatialMax

docs/src/pages/docs/api.md

@@ -31,6 +31,7 @@ const {
   refetchIntervalInBackground,
   queryFnParamsFilter,
   refetchOnMount,
+  alwaysRefetchOnMount,
   isDataEqual,
   onError,
   onSuccess,
@@ -115,6 +116,10 @@ const queryInfo = useQuery({
   - Optional
   - Defaults to `true`
   - If set to `false`, will disable additional instances of a query to trigger background refetches
+- `alwaysRefetchOnMount: Boolean`
+  - Optional
+  - Defaults to `false`
+  - Always refetch on mount sets refetching independent of the number of query instances. If `refetchOnMount` is set to false but only one query instance exists the query would refetch anyway. If `alwaysRefetchOnMount` is set to false though the query will not refetch independent of the number of instances
 - `queryFnParamsFilter: Function(args) => filteredArgs`
   - Optional
   - This function will filter the params that get passed to `queryFn`.
@@ -662,6 +667,7 @@ const queryConfig = {
     refetchInterval: false,
     queryFnParamsFilter: identity,
     refetchOnMount: true,
+    alwaysRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/config.js

@@ -17,6 +17,7 @@ export const DEFAULT_CONFIG = {
     refetchInterval: false,
     queryFnParamsFilter: identity,
     refetchOnMount: true,
+    alwaysRefetchOnMount: false,
     isDataEqual: deepEqual,
     onError: noop,
     onSuccess: noop,

src/core/queryInstance.js

@@ -55,7 +55,7 @@ export function makeQueryInstance(query, onStateUpdate) {
         query.config.enabled && // Don't auto refetch if disabled
         !query.wasSuspended && // Don't double refetch for suspense
         query.state.isStale && // Only refetch if stale
-        (query.config.refetchOnMount || query.instances.length === 1)
+        ((query.config.refetchOnMount || query.instances.length === 1) || query.config.alwaysRefetchOnMount)
       ) {
         await query.fetch()
       }

types/index.d.ts

@@ -237,6 +237,7 @@ export interface BaseQueryOptions<TResult = unknown, TError = Error> {
   refetchIntervalInBackground?: boolean
   refetchOnWindowFocus?: boolean
   refetchOnMount?: boolean
+  alwaysRefetchOnMount?: boolean
   onSuccess?: (data: TResult) => void
   onError?: (err: TError) => void
   onSettled?: (data: TResult | undefined, error: TError | null) => void