This feature release includes multiple tweaks and fixes to RTK Query functionality, additional exported TS types, and drops support for TS versions earlier than 5.0.

Changelog

RTK Query Improvements

Lazy query hooks can now be reset.

retry.fail now accepts meta as a second argument.

Tag invalidation arrays now ignore nullish values.

We did some small internal refactoring around Maps and default values that shrank bundle size slightly.

Bugfixes

Passing skipToken to a query hook now bails out before running any other logic, which fixes cases where serializeQueryArgs previously threw an error because there were no args to process.

The autoBatchEnhancer now reads window.requestAnimationFrame later, which it to work properly with Jest fake timers.

We fixed cases where the hook result isSuccess flag would briefly flicker to false when switched to a different cache entry that was uninitialized, and would briefly flicker to true when refetching a query that previously errored.

The listener middleware previously had inconsistent logic checks for comparing against existing listener entries (effect + type, vs effect only). It now always checks both effect + type.

Additional TS Types

We now export Typed[Query|Mutation]OnQueryStarted helpers to let you define onQueryStarted callbacks outside of createApi if desired.

We also now export a CreateAsyncThunkFunction type that can be used to type userland wrappers around createAsyncThunk.

TS Support Matrix Updates

We've historically tried to maintain TS backwards compatibility as long as possible, and made occasional updates to our TS support matrix in minor versions over time. As of RTK 2.3.0, we officially supported back through TS 4.7.

As of this release, we're tweaking that support policy to match the policy used by DefinitelyTyped:

Definitely Typed only tests packages on versions of TypeScript that are less than 2 years old

Given that, we've dropped official support for TS versions earlier than 5.0. (RTK may work with those versions, but we no longer test against them and won't try to fix issues with those versions.)

We'll continue to update our TS support matrix over time based on that 2-year rolling window.

What's Changed

• add example to reproduce defect of serializeQueryArgs with skipToken by @ Themezv in #4708
• Read window.rAF later to allow fake timers to work correctly by @ ensconced in #4701
• Add type helpers for OnQueryStarted callbacks by @ aryaemami59 in #4713
• Add a type for createAsyncThunk without the withTypes method by @ EskiMojo14 in #4667
• Add ability to reset lazy query hooks by @ alexmotoc in #4689
• Ignore nullish values in tag invalidations by @ pierroberto in #4671
• Allow passing meta to retry.fail, and passing baseQuery to ensure types match by @ EskiMojo14 in #4723
• Keep isSuccess: true when switching to an uninitialized cache entry by @ markerikson in #4731
• Keep isSuccess consistent when refetching after an error by @ markerikson in #4732
• Update to new version of upsert proposal, and fix listener equality checks by @ EskiMojo14 in #4735

Full Changelog: v2.3.0...v2.4.0

This feature release adds a new RTK Query upsertQueryEntries util to batch-upsert cache entries more efficiently, passes through additional values for use in prepareHeaders, and exports additional TS types around query options and selectors.

Changelog

upsertQueryEntries

RTK Query already had an upsertQueryData thunk that would upsert a single cache entry. However, some users wanted to upsert many cache entries (potentially hundreds or thousands), and found that upsertQueryData had poor performance in those cases. This is because upsertQueryData runs the full async request handling sequence, including dispatching both pending and fulfilled actions, each of which run the main reducer and update store subscribers. That means there's 2N store / UI updates per item, so upserting hundreds of items becomes extremely perf-intensive.

RTK Query now includes an api.util.upsertQueryEntries action that is meant to handle the batched upsert use case more efficiently. It's a single synchronous action that accepts an array of many {endpointName, arg, value} entries to upsert. This results in a single store update, making this vastly better for performance vs many individual upsertQueryData calls.

We see this as having two main use cases. The first is prefilling the cache with data retrieved from storage on app startup (and it's worth noting that upsertQueryEntries can accept entries for many different endpoints as part of the same array).

The second is to act as a "pseudo-normalization" tool. RTK Query is not a "normalized" cache. However, there are times when you may want to prefill other cache entries with the contents of another endpoint, such as taking the results of a getPosts list endpoint response and prefilling the individual getPost(id) endpoint cache entries, so that components that reference an individual item endpoint already have that data available.

Currently, you can implement the "pseudo-normalization" approach by dispatching upsertQueryEntries in an endpoint lifecycle, like this:

    <span class="pl-c">// Pre-fill the individual post entries with the results</span>
    <span class="pl-c">// from the list endpoint query</span>
    <span class="pl-en">dispatch</span><span class="pl-kos">(</span>
      <span class="pl-s1">api</span><span class="pl-kos">.</span><span class="pl-c1">util</span><span class="pl-kos">.</span><span class="pl-en">upsertQueryEntries</span><span class="pl-kos">(</span>
        <span class="pl-s1">posts</span><span class="pl-kos">.</span><span class="pl-en">map</span><span class="pl-kos">(</span><span class="pl-kos">(</span><span class="pl-s1">post</span><span class="pl-kos">)</span> <span class="pl-c1">=&gt;</span> <span class="pl-kos">(</span><span class="pl-kos">{</span>
          <span class="pl-c1">endpointName</span>: <span class="pl-s">'getPost'</span><span class="pl-kos">,</span>
          <span class="pl-c1">arg</span>: <span class="pl-kos">{</span> <span class="pl-c1">id</span>: <span class="pl-s1">post</span><span class="pl-kos">.</span><span class="pl-c1">id</span> <span class="pl-kos">}</span><span class="pl-kos">,</span>
          <span class="pl-c1">value</span>: <span class="pl-s1">post</span><span class="pl-kos">,</span>
        <span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">)</span><span class="pl-kos">,</span>
      <span class="pl-kos">)</span><span class="pl-kos">,</span>
    <span class="pl-kos">)</span>
  <span class="pl-kos">}</span><span class="pl-kos">,</span>
<span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">,</span>
<span class="pl-c1">getPost</span>: <span class="pl-s1">build</span><span class="pl-kos">.</span><span class="pl-en">query</span><span class="pl-c1">&lt;</span><span class="pl-smi">Post</span><span class="pl-kos">,</span> <span class="pl-smi">Pick</span><span class="pl-c1">&lt;</span><span class="pl-smi">Post</span><span class="pl-kos">,</span> <span class="pl-s">'id'</span><span class="pl-c1">&gt;</span><span class="pl-c1">&gt;</span><span class="pl-kos">(</span><span class="pl-kos">{</span>
  <span class="pl-en">query</span>: <span class="pl-kos">(</span><span class="pl-s1">post</span><span class="pl-kos">)</span> <span class="pl-c1">=&gt;</span> <span class="pl-s">`post/<span class="pl-s1"><span class="pl-kos">${</span><span class="pl-s1">post</span><span class="pl-kos">.</span><span class="pl-c1">id</span><span class="pl-kos">}</span></span>`</span><span class="pl-kos">,</span>
<span class="pl-kos">}</span><span class="pl-kos">)</span><span class="pl-kos">,</span>

Down the road we may add a new option to query endpoints that would let you provide the mapping function and have it automatically update the corresponding entries.

For additional comparisons between upsertQueryData and upsertQueryEntries, see the upsertQueryEntries API reference.

prepareHeaders Options

The prepareHeaders callback for fetchBaseQuery now receives two additional values in the api argument:

• arg: the URL string or FetchArgs object that was passed in to fetchBaseQuery for this endpoint
• extraOptions: any extra options that were provided to the base query

Additional TS Types

We've added a TypedQueryStateSelector type that can be used to pre-type selectors for use with selectFromResult:

We've also exported several additional TS types around base queries and tag definitions.

What's Changed

• Fix serializeQueryArgs type by @ Reedgern in #4658
• Add the TypedQueryStateSelector helper type by @ aryaemami59 in #4656
• Pass query args to prepareHeaders function by @ kyletsang in #4638
• Implement a util function to batch-upsert cache entries by @ markerikson in #4561
• fetchBaseQuery: expose extraOptions to prepareHeaders by @ phryneas in #4291

Full Changelog: v2.2.8...v2.3.0