refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions #9224

braden-w · 2025-05-30T17:09:45Z

This PR simplifies InfiniteQueryObserverOptions by removing the unnecessary TQueryData generic parameter.

For infinite queries, the actual data stored in the cache is the per-page data (defined by TQueryFnData) wrapped within an InfiniteData structure: InfiniteData<TQueryFnData, TPageParam>.

The previous definition of InfiniteQueryObserverOptions introduced an intermediate generic, TQueryData, which was defaulted to TQueryFnData. This TQueryData was then used to define the cached structure as InfiniteData<TQueryData, TPageParam>.

// Before:
export interface InfiniteQueryObserverOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryData = TQueryFnData, // <-- Initialized TQueryData, always the same as TQueryFnData
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
> extends QueryObserverOptions<
      TQueryFnData,
      TError,
      TData,
      InfiniteData<TQueryData, TPageParam>, // <-- Used the intermediate TQueryData
      TQueryKey,
      TPageParam
    >,
    InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {}

This intermediate TQueryData step was redundant because the type of the data for each page (TQueryFnData) is already known. The cached data structure can therefore directly use TQueryFnData.

This change removes the TQueryData generic, simplifying the type signature:

// After:
export interface InfiniteQueryObserverOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
> extends QueryObserverOptions<
      TQueryFnData,
      TError,
      TData,
      InfiniteData<TQueryFnData, TPageParam>, // <-- Directly uses TQueryFnData
      TQueryKey,
      TPageParam
    >,
    InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> {}

This simplification reduces complexity and makes the type definition more direct.

The update has been consistently applied across:

Core type definitions in packages/query-core/src/types.ts (notably InfiniteQueryObserverOptions and DefaultedInfiniteQueryObserverOptions).
The InfiniteQueryObserver class in packages/query-core/src/infiniteQueryObserver.ts.
Type definitions and helper functions (e.g., infiniteQueryOptions, UseInfiniteQueryOptions) in framework packages (react-query, vue-query, solid-query, angular-query-experimental).
Associated test files to ensure type correctness with the new signatures.

…rOptions

…): remove unnecessary TQueryData in InfiniteQueryObserverOptions

nx-cloud · 2025-05-30T17:10:15Z

View your CI Pipeline Execution ↗ for commit e368b11.

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	2m 52s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1m 43s	View ↗

☁️ Nx Cloud last updated this comment at 2025-06-02 17:27:49 UTC

pkg-pr-new · 2025-05-30T17:14:34Z

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@9224

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9224

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9224

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9224

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9224

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9224

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9224

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9224

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9224

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9224

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9224

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9224

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9224

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9224

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9224

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9224

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9224

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9224

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9224

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9224

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9224

commit: e368b11

codecov · 2025-05-30T17:16:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.66%. Comparing base (0e083c6) to head (e368b11).
Report is 6 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #9224       +/-   ##
===========================================
+ Coverage   45.37%   59.66%   +14.28%     
===========================================
  Files         209      138       -71     
  Lines        8267     5511     -2756     
  Branches     1864     1479      -385     
===========================================
- Hits         3751     3288      -463     
+ Misses       4076     1925     -2151     
+ Partials      440      298      -142

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`85.04% <ø> (ø)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`24.39% <ø> (ø)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`98.15% <100.00%> (+<0.01%)`	⬆️
@tanstack/query-devtools	`3.55% <0.00%> (-0.01%)`	⬇️
@tanstack/query-persist-client-core	`78.32% <ø> (ø)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/query-test-utils	`∅ <ø> (∅)`
@tanstack/react-query	`96.02% <ø> (ø)`
@tanstack/react-query-devtools	`10.00% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`78.20% <ø> (ø)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`100.00% <ø> (ø)`
@tanstack/svelte-query	`88.15% <ø> (ø)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (ø)`
@tanstack/vue-query	`70.85% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

TkDodo · 2025-06-02T17:23:05Z

I wanted to get this done for so long but couldn’t fully wrap my head around it. Thank you 🙏

…finiteQueryObserverOptions

TkDodo · 2025-06-02T17:25:27Z

btw @braden-w if you’re on Discord, I’d love to connect ❤️ . Let me know if you plan to stick around, your contributions are awesome 🙌

braden-w · 2025-06-02T17:31:23Z

Amazing, thank you @TkDodo for your work and comments on my previous PRs!! This week is busy but I'll do my best to update them sometime next week :) and would love to connect on Discord! I just sent you a message and friend request.

disintegrator · 2025-06-03T11:39:16Z

Hey @braden-w @TkDodo, this change turns out to be a breaking change. At least for folks like us that work with the UseInfiniteQueryOptions type that's now changed from 6 to 5 type parameters. We're currently looking at alternatives that don't require us to depend on that type but I think it's worth flagging.

TkDodo · 2025-06-03T11:50:14Z

Thanks for flagging. I’m very cautious about accidental breaking changes, but it’s not really feasible doing that for types, too. We’ve noted that here:

https://tanstack.com/query/v5/docs/framework/react/typescript

Changes to types in this repository are considered non-breaking and are usually released as patch semver changes (otherwise every type enhancement would be a major version!).

disintegrator · 2025-06-03T11:53:39Z

Thanks @TkDodo that's totally fair. We'll figure something out. This one has meaningful impact for folks building libraries of hooks that wrap react query primitives. Especially painful if it means going from peer dependency of "@tanstack/react-query": "^5" to "@tanstack/react-query": "^5.80" as it will likely mean that some existing consumer may end up with two or more installs of the react query.

My current plan is to inline the type in my library. It should break the dependency on UseInfiniteQueryOptions and allow me to maintain "@tanstack/react-query": "^5" as peer dep requirement.

braden-w added 2 commits May 30, 2025 10:04

refactor(core): remove unnecessary TQueryData in InfiniteQueryObserve…

93fcdbd

…rOptions

refactor(react-query,solid-query,svelte-query,vue-query,angular-query…

e502ce0

…): remove unnecessary TQueryData in InfiniteQueryObserverOptions

braden-w changed the title ~~refactor: remove unnecessary TQueryData in InfiniteQueryObserverOptions~~ refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions May 30, 2025

github-actions bot added package: react-query package: vue-query package: query-core package: solid-query package: svelte-query package: angular-query-experimental labels May 30, 2025

ci: apply automated fixes

b057113

TkDodo approved these changes Jun 2, 2025

View reviewed changes

Merge branch 'main' into refactor/remove-unnecessary-TQueryData-in-In…

e368b11

…finiteQueryObserverOptions

TkDodo merged commit efa963d into TanStack:main Jun 2, 2025
7 checks passed

BTBas mentioned this pull request Jun 4, 2025

UseInfiniteQueryOptions type changed in TanStack Query 5.80.0 orval-labs/orval#2145

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions #9224

refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions #9224

Uh oh!

braden-w commented May 30, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented May 30, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented May 30, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 30, 2025 •

edited

Loading

Uh oh!

TkDodo commented Jun 2, 2025

Uh oh!

TkDodo commented Jun 2, 2025

Uh oh!

braden-w commented Jun 2, 2025

Uh oh!

Uh oh!

disintegrator commented Jun 3, 2025 •

edited

Loading

Uh oh!

TkDodo commented Jun 3, 2025

Uh oh!

disintegrator commented Jun 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions #9224

refactor: remove unnecessary TQueryData generic in InfiniteQueryObserverOptions #9224

Uh oh!

Conversation

braden-w commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TkDodo commented Jun 2, 2025

Uh oh!

TkDodo commented Jun 2, 2025

Uh oh!

braden-w commented Jun 2, 2025

Uh oh!

Uh oh!

disintegrator commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TkDodo commented Jun 3, 2025

Uh oh!

disintegrator commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

braden-w commented May 30, 2025 •

edited

Loading

nx-cloud bot commented May 30, 2025 •

edited

Loading

pkg-pr-new bot commented May 30, 2025 •

edited

Loading

codecov bot commented May 30, 2025 •

edited

Loading

disintegrator commented Jun 3, 2025 •

edited

Loading

disintegrator commented Jun 3, 2025 •

edited

Loading