feat(react-query): backport v5 apis about infinite query by manudeli · Pull Request #9334 · TanStack/query

manudeli · 2025-06-29T12:48:38Z

New Features and Utilities:

Added infiniteQueryOptions
Added useSuspenseInfiniteQuery
Added type DefinedInitialDataInfiniteOptions, type UndefinedInitialDataInfiniteOptions
Added function overload for useInfiniteQuery to return DefinedUseInfiniteQueryResult when using infiniteData

Deprecations:

Marked several overloads of useInfiniteQuery as deprecated, with a note that they will be removed in the next major version. (packages/react-query/src/useInfiniteQuery.ts)

nx-cloud · 2025-06-29T12:49:34Z

View your CI Pipeline Execution ↗ for commit 32d3516

Command	Status	Duration	Result
`nx affected --targets=test:lib,test:types,test:...`	✅ Succeeded	20s	View ↗
`nx affected --targets=test:lib --base=508d5a066...`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-09-09 07:09:48 UTC

Copilot

Pull Request Overview

This PR backports infinite query APIs from React Query v5 to provide enhanced infinite query functionality and improve API consistency.

Added useSuspenseInfiniteQuery hook for suspense-based infinite queries with automatic error boundaries
Added infiniteQueryOptions function for creating type-safe infinite query configurations
Deprecated multiple function overloads in useQuery and useInfiniteQuery with improved deprecation messages

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/react-query/src/useSuspenseInfiniteQuery.ts	New suspense-based infinite query hook implementation
packages/react-query/src/infiniteQueryOptions.ts	New infinite query options factory function with type definitions
packages/react-query/src/types.ts	Added new result types for suspense and defined infinite queries
packages/react-query/src/useQuery.ts	Enhanced deprecation messages for function overloads
packages/react-query/src/useInfiniteQuery.ts	Added new overload and enhanced deprecation messages
packages/react-query/src/queryOptions.ts	Updated to omit prohibited v5 keys from options
packages/react-query/src/index.ts	Exported new functions and types
packages/react-query/src/tests/*	Comprehensive type and unit tests for new functionality
packages/query-core/src/types.ts	Cleaned up deprecated comment formatting
packages/query-core/src/queryClient.ts	Cleaned up deprecated comment formatting
packages/query-core/src/queryCache.ts	Cleaned up deprecated comment formatting

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Comments suppressed due to low confidence (1)

packages/react-query/src/infiniteQueryOptions.ts:22

The type name ProhibitedInfiniteQueryOptionsKeyInV5 is inconsistent with the similar type in queryOptions.ts which is named ProhibitedQueryOptionsKeyInV5. Consider renaming to ProhibitedQueryOptionsKeyInV5 for consistency.

  'useErrorBoundary' | 'suspense'

Copilot · 2025-07-29T15:34:41Z

packages/react-query/src/queryOptions.ts

-  DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
+  OmitKeyof<
+    DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
+    ProhibitedQueryOptionsKeyInV5


The type ProhibitedQueryOptionsKeyInV5 is referenced but not defined in this file. This will cause a TypeScript compilation error.

Copilot · 2025-07-29T15:34:41Z

packages/react-query/src/queryOptions.ts

-  UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
+  OmitKeyof<
+    UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
+    ProhibitedQueryOptionsKeyInV5


The type ProhibitedQueryOptionsKeyInV5 is referenced but not defined in this file. This will cause a TypeScript compilation error.

codesandbox-ci · 2025-07-29T15:35:15Z

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 32d3516:

Sandbox	Source
@tanstack/query-example-react-basic-typescript	Configuration
@tanstack/query-example-solid-basic-typescript	Configuration
@tanstack/query-example-svelte-basic	Configuration
@tanstack/query-example-vue-basic	Configuration

manudeli

@TkDodo I left comments with my intentions

manudeli · 2025-07-29T16:01:59Z

packages/react-query/src/useInfiniteQuery.ts

+export function useInfiniteQuery<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+>(
+  options: UseInfiniteQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryFnData,
+    TQueryKey
+  > & {
+    initialData:
+      | NonUndefinedGuard<InfiniteData<TQueryFnData>>
+      | (() => NonUndefinedGuard<InfiniteData<TQueryFnData>>)
+      | undefined
+  },
+): DefinedUseInfiniteQueryResult<TData, TError>


Another function overload that returns DefinedUseInfiniteQueryResult is added when using initialData.

@tanstack/react-query v5 also support this

manudeli · 2025-07-29T16:02:46Z

packages/react-query/src/types.ts

+export type DefinedUseInfiniteQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = DefinedInfiniteQueryObserverResult<TData, TError>
+
+export type UseSuspenseInfiniteQueryResult<
+  TData = unknown,
+  TError = unknown,
+> = OmitKeyof<
+  DefinedInfiniteQueryObserverResult<TData, TError>,
+  'isPlaceholderData'
+>


manudeli · 2025-07-29T16:11:08Z

packages/react-query/src/useInfiniteQuery.ts

    TQueryKey
  >,
 ): UseInfiniteQueryResult<TData, TError>
+/** @deprecated This function overload will be removed in the next major version. */


Mark some useInfiniteQuery's function overloads as deprecated

coderabbitai · 2025-08-24T07:17:22Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

…ryOptions for enhanced infinite query handling - Added `useSuspenseInfiniteQuery` hook for improved suspense handling with infinite queries. - Introduced `infiniteQueryOptions` function to streamline infinite query option management. - Updated types to include `DefinedInfiniteQueryObserverResult` and related types for better type safety. - Refactored existing query options to accommodate new infinite query features. - Added tests for new functionalities to ensure correctness and type safety.

manudeli self-assigned this Jun 29, 2025

manudeli mentioned this pull request Jun 30, 2025

fix(react-query): update peerDependency, @tanstack/react-query to version 4.40.0 and deprecate old options toss/suspensive#1639

Merged

1 task

manudeli force-pushed the react-query/backport-infinite-query branch from 5b39d68 to 8e281a9 Compare July 16, 2025 06:06

manudeli requested a review from Copilot July 16, 2025 09:14

This comment was marked as outdated.

Sign in to view

manudeli requested a review from Copilot July 16, 2025 09:25

This comment was marked as outdated.

Sign in to view

manudeli requested a review from Copilot July 16, 2025 09:35

This comment was marked as outdated.

Sign in to view

manudeli force-pushed the react-query/backport-infinite-query branch from 91170ba to 89fb2fb Compare July 29, 2025 15:33

manudeli requested a review from Copilot July 29, 2025 15:33

Copilot AI reviewed Jul 29, 2025

View reviewed changes

manudeli marked this pull request as ready for review July 29, 2025 15:46

manudeli requested a review from TkDodo July 29, 2025 15:59

manudeli force-pushed the react-query/backport-infinite-query branch from 15a9bcf to 9aaf337 Compare July 29, 2025 16:09

manudeli commented Jul 29, 2025

View reviewed changes

manudeli mentioned this pull request Aug 12, 2025

feat(codemods, docs): remove deprecated api for react-query-4 in tanstack-query-import toss/suspensive#1672

Merged

1 task

manudeli force-pushed the react-query/backport-infinite-query branch from c239705 to 16c08c1 Compare August 24, 2025 09:36

joseph0926 mentioned this pull request Sep 6, 2025

[v4] fix(ci): resolve v4 CI timeout by disabling Nx Cloud distributed execution #9623

Merged

manudeli force-pushed the react-query/backport-infinite-query branch from 94085b4 to ed2a35b Compare September 9, 2025 07:03

chore: update

32d3516

manudeli merged commit 208029e into TanStack:v4 Sep 9, 2025
4 checks passed

Uh oh!

Conversation

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

Uh oh!

New Features and Utilities:

Deprecations:

Uh oh!

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

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

codesandbox-ci bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manudeli left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

manudeli Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

manudeli Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

manudeli Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Aug 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other AI code review bot(s) detected

Review skipped

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

manudeli commented Jun 29, 2025 •

edited

Loading

nx-cloud bot commented Jun 29, 2025 •

edited

Loading

codesandbox-ci bot commented Jul 29, 2025 •

edited

Loading

manudeli left a comment •

edited

Loading

manudeli Jul 29, 2025 •

edited

Loading

coderabbitai bot commented Aug 24, 2025 •

edited

Loading