@tanstack/react-query 4.40.2 → 4.41.0

package/build/lib/useSuspenseInfiniteQuery.d.ts

@@ -0,0 +1,5 @@
+import type { OmitKeyof, QueryKey, WithRequired } from '@tanstack/query-core';
+import type { UseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from './types';
+export declare type UseSuspenseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = WithRequired<OmitKeyof<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode' | 'initialData'>, 'queryKey'>;
+export declare function useSuspenseInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseSuspenseInfiniteQueryResult<TData, TError>;
+//# sourceMappingURL=useSuspenseInfiniteQuery.d.ts.map

package/build/lib/useSuspenseInfiniteQuery.esm.js

@@ -0,0 +1,14 @@
+import { InfiniteQueryObserver } from '@tanstack/query-core';
+import { useBaseQuery } from './useBaseQuery.esm.js';
+
+function useSuspenseInfiniteQuery(options) {
+  return useBaseQuery({ ...options,
+    enabled: true,
+    suspense: true,
+    useErrorBoundary: true,
+    networkMode: 'always'
+  }, InfiniteQueryObserver);
+}
+
+export { useSuspenseInfiniteQuery };
+//# sourceMappingURL=useSuspenseInfiniteQuery.esm.js.map

package/build/lib/useSuspenseInfiniteQuery.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSuspenseInfiniteQuery.esm.js","sources":["../../src/useSuspenseInfiniteQuery.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n  InfiniteQueryObserverSuccessResult,\n  OmitKeyof,\n  QueryKey,\n  QueryObserver,\n  WithRequired,\n} from '@tanstack/query-core'\nimport type {\n  UseInfiniteQueryOptions,\n  UseSuspenseInfiniteQueryResult,\n} from './types'\n\nexport type UseSuspenseInfiniteQueryOptions<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n> = WithRequired<\n  OmitKeyof<\n    UseInfiniteQueryOptions<\n      TQueryFnData,\n      TError,\n      TData,\n      TQueryFnData,\n      TQueryKey\n    >,\n    | 'suspense'\n    | 'useErrorBoundary'\n    | 'enabled'\n    | 'placeholderData'\n    | 'networkMode'\n    | 'initialData'\n  >,\n  'queryKey'\n>\n\nexport function useSuspenseInfiniteQuery<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  options: UseSuspenseInfiniteQueryOptions<\n    TQueryFnData,\n    TError,\n    TData,\n    TQueryKey\n  >,\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n  return useBaseQuery(\n    {\n      ...options,\n      enabled: true,\n      suspense: true,\n      useErrorBoundary: true,\n      networkMode: 'always',\n    },\n    InfiniteQueryObserver as typeof QueryObserver,\n  ) as InfiniteQueryObserverSuccessResult<TData, TError>\n}\n"],"names":["useSuspenseInfiniteQuery","options","useBaseQuery","enabled","suspense","useErrorBoundary","networkMode","InfiniteQueryObserver"],"mappings":";;;AAsCO,SAASA,wBAAT,CAMLC,OANK,EAY0C;AAC/C,EAAA,OAAOC,YAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,QAAQ,EAAE,IAHZ;AAIEC,IAAAA,gBAAgB,EAAE,IAJpB;AAKEC,IAAAA,WAAW,EAAE,QAAA;GANE,EAQjBC,qBARiB,CAAnB,CAAA;AAUD;;;;"}

package/build/lib/useSuspenseInfiniteQuery.js

@@ -0,0 +1,18 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var queryCore = require('@tanstack/query-core');
+var useBaseQuery = require('./useBaseQuery.js');
+
+function useSuspenseInfiniteQuery(options) {
+  return useBaseQuery.useBaseQuery({ ...options,
+    enabled: true,
+    suspense: true,
+    useErrorBoundary: true,
+    networkMode: 'always'
+  }, queryCore.InfiniteQueryObserver);
+}
+
+exports.useSuspenseInfiniteQuery = useSuspenseInfiniteQuery;
+//# sourceMappingURL=useSuspenseInfiniteQuery.js.map

package/build/lib/useSuspenseInfiniteQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSuspenseInfiniteQuery.js","sources":["../../src/useSuspenseInfiniteQuery.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n  InfiniteQueryObserverSuccessResult,\n  OmitKeyof,\n  QueryKey,\n  QueryObserver,\n  WithRequired,\n} from '@tanstack/query-core'\nimport type {\n  UseInfiniteQueryOptions,\n  UseSuspenseInfiniteQueryResult,\n} from './types'\n\nexport type UseSuspenseInfiniteQueryOptions<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n> = WithRequired<\n  OmitKeyof<\n    UseInfiniteQueryOptions<\n      TQueryFnData,\n      TError,\n      TData,\n      TQueryFnData,\n      TQueryKey\n    >,\n    | 'suspense'\n    | 'useErrorBoundary'\n    | 'enabled'\n    | 'placeholderData'\n    | 'networkMode'\n    | 'initialData'\n  >,\n  'queryKey'\n>\n\nexport function useSuspenseInfiniteQuery<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  options: UseSuspenseInfiniteQueryOptions<\n    TQueryFnData,\n    TError,\n    TData,\n    TQueryKey\n  >,\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n  return useBaseQuery(\n    {\n      ...options,\n      enabled: true,\n      suspense: true,\n      useErrorBoundary: true,\n      networkMode: 'always',\n    },\n    InfiniteQueryObserver as typeof QueryObserver,\n  ) as InfiniteQueryObserverSuccessResult<TData, TError>\n}\n"],"names":["useSuspenseInfiniteQuery","options","useBaseQuery","enabled","suspense","useErrorBoundary","networkMode","InfiniteQueryObserver"],"mappings":";;;;;;;AAsCO,SAASA,wBAAT,CAMLC,OANK,EAY0C;AAC/C,EAAA,OAAOC,yBAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,QAAQ,EAAE,IAHZ;AAIEC,IAAAA,gBAAgB,EAAE,IAJpB;AAKEC,IAAAA,WAAW,EAAE,QAAA;GANE,EAQjBC,+BARiB,CAAnB,CAAA;AAUD;;;;"}

package/build/lib/useSuspenseInfiniteQuery.mjs

@@ -0,0 +1,14 @@
+import { InfiniteQueryObserver } from '@tanstack/query-core';
+import { useBaseQuery } from './useBaseQuery.mjs';
+
+function useSuspenseInfiniteQuery(options) {
+  return useBaseQuery({ ...options,
+    enabled: true,
+    suspense: true,
+    useErrorBoundary: true,
+    networkMode: 'always'
+  }, InfiniteQueryObserver);
+}
+
+export { useSuspenseInfiniteQuery };
+//# sourceMappingURL=useSuspenseInfiniteQuery.mjs.map

package/build/lib/useSuspenseInfiniteQuery.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSuspenseInfiniteQuery.mjs","sources":["../../src/useSuspenseInfiniteQuery.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport { useBaseQuery } from './useBaseQuery'\nimport type {\n  InfiniteQueryObserverSuccessResult,\n  OmitKeyof,\n  QueryKey,\n  QueryObserver,\n  WithRequired,\n} from '@tanstack/query-core'\nimport type {\n  UseInfiniteQueryOptions,\n  UseSuspenseInfiniteQueryResult,\n} from './types'\n\nexport type UseSuspenseInfiniteQueryOptions<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n> = WithRequired<\n  OmitKeyof<\n    UseInfiniteQueryOptions<\n      TQueryFnData,\n      TError,\n      TData,\n      TQueryFnData,\n      TQueryKey\n    >,\n    | 'suspense'\n    | 'useErrorBoundary'\n    | 'enabled'\n    | 'placeholderData'\n    | 'networkMode'\n    | 'initialData'\n  >,\n  'queryKey'\n>\n\nexport function useSuspenseInfiniteQuery<\n  TQueryFnData = unknown,\n  TError = unknown,\n  TData = TQueryFnData,\n  TQueryKey extends QueryKey = QueryKey,\n>(\n  options: UseSuspenseInfiniteQueryOptions<\n    TQueryFnData,\n    TError,\n    TData,\n    TQueryKey\n  >,\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n  return useBaseQuery(\n    {\n      ...options,\n      enabled: true,\n      suspense: true,\n      useErrorBoundary: true,\n      networkMode: 'always',\n    },\n    InfiniteQueryObserver as typeof QueryObserver,\n  ) as InfiniteQueryObserverSuccessResult<TData, TError>\n}\n"],"names":["useSuspenseInfiniteQuery","options","useBaseQuery","enabled","suspense","useErrorBoundary","networkMode","InfiniteQueryObserver"],"mappings":";;;AAsCO,SAASA,wBAAT,CAMLC,OANK,EAY0C;AAC/C,EAAA,OAAOC,YAAY,CACjB,EACE,GAAGD,OADL;AAEEE,IAAAA,OAAO,EAAE,IAFX;AAGEC,IAAAA,QAAQ,EAAE,IAHZ;AAIEC,IAAAA,gBAAgB,EAAE,IAJpB;AAKEC,IAAAA,WAAW,EAAE,QAAA;GANE,EAQjBC,qBARiB,CAAnB,CAAA;AAUD;;;;"}

package/build/umd/index.development.js

@@ -3737,6 +3737,13 @@
     return result.isError && !errorResetBoundary.isReset() && !result.isFetching && shouldThrowError(useErrorBoundary, [result.error, query]);
   };
 
+  /**
+   * Ensures minimum staleTime and cacheTime values when suspense is enabled.
+   * Despite the name, this function guards both staleTime and cacheTime to prevent
+   * infinite re-render loops with synchronous queries.
+   *
+   * @deprecated in v5 - replaced by ensureSuspenseTimers
+   */
   const ensureStaleTime = defaultedOptions => {
     if (defaultedOptions.suspense) {
       // Always set stale time when using suspense to prevent
@@ -3744,6 +3751,10 @@
       if (typeof defaultedOptions.staleTime !== 'number') {
         defaultedOptions.staleTime = 1000;
       }
+
+      if (typeof defaultedOptions.cacheTime === 'number') {
+        defaultedOptions.cacheTime = Math.max(defaultedOptions.cacheTime, 1000);
+      }
     }
   };
   const willFetch = (result, isRestoring) => result.isLoading && result.isFetching && !isRestoring;
@@ -3906,6 +3917,15 @@
     }, QueryObserver);
   }
 
+  function useSuspenseInfiniteQuery(options) {
+    return useBaseQuery({ ...options,
+      enabled: true,
+      suspense: true,
+      useErrorBoundary: true,
+      networkMode: 'always'
+    }, InfiniteQueryObserver);
+  }
+
   function useSuspenseQueries({
     queries,
     context
@@ -3926,6 +3946,10 @@
     return options;
   }
 
+  function infiniteQueryOptions(options) {
+    return options;
+  }
+
   function useHydrate(state, options = {}) {
     const queryClient = useQueryClient({
       context: options.context
@@ -4020,6 +4044,7 @@
   exports.focusManager = focusManager;
   exports.hashQueryKey = hashQueryKey;
   exports.hydrate = hydrate;
+  exports.infiniteQueryOptions = infiniteQueryOptions;
   exports.isCancelledError = isCancelledError;
   exports.isError = isError;
   exports.isServer = isServer;
@@ -4042,6 +4067,7 @@
   exports.useQuery = useQuery;
   exports.useQueryClient = useQueryClient;
   exports.useQueryErrorResetBoundary = useQueryErrorResetBoundary;
+  exports.useSuspenseInfiniteQuery = useSuspenseInfiniteQuery;
   exports.useSuspenseQueries = useSuspenseQueries;
   exports.useSuspenseQuery = useSuspenseQuery;