@tanstack/query-core 5.0.0-alpha.61 → 5.0.0-alpha.66

package/src/tests/queryClient.test.tsx

@@ -649,6 +649,46 @@ describe('queryClient', () => {
         pageParams: [10],
       })
     })
+
+    test('should prefetch multiple pages', async () => {
+      const key = queryKey()
+
+      await queryClient.prefetchInfiniteQuery({
+        queryKey: key,
+        queryFn: ({ pageParam }) => String(pageParam),
+        getNextPageParam: (_lastPage, _pages, lastPageParam) =>
+          lastPageParam + 5,
+        defaultPageParam: 10,
+        pages: 3,
+      })
+
+      const result = queryClient.getQueryData(key)
+
+      expect(result).toEqual({
+        pages: ['10', '15', '20'],
+        pageParams: [10, 15, 20],
+      })
+    })
+
+    test('should stop prefetching if getNextPageParam returns undefined', async () => {
+      const key = queryKey()
+
+      await queryClient.prefetchInfiniteQuery({
+        queryKey: key,
+        queryFn: ({ pageParam }) => String(pageParam),
+        getNextPageParam: (_lastPage, _pages, lastPageParam) =>
+          lastPageParam >= 20 ? undefined : lastPageParam + 5,
+        defaultPageParam: 10,
+        pages: 5,
+      })
+
+      const result = queryClient.getQueryData(key)
+
+      expect(result).toEqual({
+        pages: ['10', '15', '20'],
+        pageParams: [10, 15, 20],
+      })
+    })
   })
 
   describe('prefetchQuery', () => {

package/src/types.ts

@@ -358,20 +358,28 @@ export interface FetchQueryOptions<
   staleTime?: number
 }
 
-export interface FetchInfiniteQueryOptions<
+type FetchInfiniteQueryPages<TQueryFnData = unknown, TPageParam = unknown> =
+  | { pages?: never; getNextPageParam?: never }
+  | {
+      pages: number
+      getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
+    }
+
+export type FetchInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
   TPageParam = unknown,
-> extends FetchQueryOptions<
-      TQueryFnData,
-      TError,
-      InfiniteData<TData>,
-      TQueryKey,
-      TPageParam
-    >,
-    DefaultPageParam<TPageParam> {}
+> = FetchQueryOptions<
+  TQueryFnData,
+  TError,
+  InfiniteData<TData>,
+  TQueryKey,
+  TPageParam
+> &
+  DefaultPageParam<TPageParam> &
+  FetchInfiniteQueryPages<TQueryFnData, TPageParam>
 
 export interface ResultOptions {
   throwOnError?: boolean