Add refetchCachedPages option for infinite query

[rossmartin]

This refetchCachedPages option allows an infinite query to NOT refetch all pages in the cache when a refetch happens. By default it is true and uses the existing behavior.

This is based on what was mentioned in the discussion here - #5011. It's also based on this resolved issue here - #4920

We want the ability to opt out of this behavior at this level. We don't want to have to reset the pages/pageParams for a query when args change or during a refetch.

Here is an example of how it can be used:

    getPosts: builder.infiniteQuery<GetPostsResponse, GetPostsRequest, string | undefined>({
      infiniteQueryOptions: {
        // ...
        refetchCachedPages: false,
      },
      // ...
    }),  

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 81715b2:

Sandbox	Source
@examples-query-react/basic	Configuration
@examples-query-react/advanced	Configuration
@examples-action-listener/counter	Configuration
rtk-esm-cra	Configuration

[netlify]

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	81715b2
🔍 Latest deploy log	https://app.netlify.com/projects/redux-starter-kit-docs/deploys/69238d6bfb3b4000086ec72c
😎 Deploy Preview	https://deploy-preview-5016--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[JacobJaffe]

Any update on this PR? This behavior is super helpful-- I've been patching this onto my projects (and can continue to, but it's tedious to build a new patch for each rtk version update), and refreshing has been working great with it.

[markerikson]

I'll try to find some time to review it in the next few days. Good to know that A) it's useful, and B) the approach appears to be working - thanks for that feedback!

[markerikson]

Out in https://github.com/reduxjs/redux-toolkit/releases/tag/v2.11.0 ! Thanks!