feat(infiniteQuery): add possibility to decide which pages should be refetched

refetchPage signature now takes page, index, allPages

this is the same signature as e.g. Array.prototype.map

Author: TkDodo

src/core/infiniteQueryBehavior.ts

@@ -109,7 +109,7 @@ export function infiniteQueryBehavior<
 
           const shouldFetchFirstPage =
             refetchPage && oldPages[0]
-              ? refetchPage(oldPages[0], oldPages)
+              ? refetchPage(oldPages[0], 0, oldPages)
               : true
 
           // Fetch first page
@@ -122,7 +122,7 @@ export function infiniteQueryBehavior<
             promise = promise.then(pages => {
               const shouldFetchNextPage =
                 refetchPage && oldPages[i]
-                  ? refetchPage(oldPages[i], oldPages)
+                  ? refetchPage(oldPages[i], i, oldPages)
                   : true
 
               if (shouldFetchNextPage) {

src/core/tests/queryClient.test.tsx

@@ -946,7 +946,7 @@ describe('queryClient', () => {
 
       await queryClient.refetchQueries(
         { queryKey: key },
-        { refetchPage: (page, allPages) => page === allPages[0] }
+        { refetchPage: (_, index) => index === 0 }
       )
 
       expect(queryClient.getQueryData(key)).toMatchObject({
@@ -974,7 +974,7 @@ describe('queryClient', () => {
       await queryClient.invalidateQueries(
         { queryKey: key, refetchInactive: true },
         {
-          refetchPage: (page, allPages) => {
+          refetchPage: (page, _, allPages) => {
             return page === allPages[0]
           },
         }
@@ -1007,7 +1007,7 @@ describe('queryClient', () => {
       await queryClient.resetQueries(
         { queryKey: key, inactive: true },
         {
-          refetchPage: (page, allPages) => {
+          refetchPage: (page, _, allPages) => {
             return page === allPages[0]
           },
         }

src/core/types.ts

@@ -237,7 +237,11 @@ export interface ResultOptions {
 }
 
 export interface RefetchPageOptions<TQueryFnData = unknown> {
-  refetchPage: (lastPage: TQueryFnData, allPages: TQueryFnData[]) => boolean
+  refetchPage: (
+    lastPage: TQueryFnData,
+    index: number,
+    allPages: TQueryFnData[]
+  ) => boolean
 }
 
 export interface RefetchOptions<TQueryFnData = unknown>

src/react/tests/useInfiniteQuery.test.tsx

@@ -619,7 +619,7 @@ describe('useInfiniteQuery', () => {
         setActTimeout(() => {
           multiplier.current = 2
           refetch({
-            refetchPage: (page, allPages) => page === allPages[0],
+            refetchPage: (_, index) => index === 0,
           })
         }, 20)
       }, [fetchNextPage, refetch])