feat(react-query): backport v5 apis about infinite query #9334
+627
−176
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
View your CI Pipeline Execution ↗ for commit 91170ba
☁️ Nx Cloud last updated this comment at |
1 task
manudeli
force-pushed
the
react-query/backport-infinite-query
branch
from
5b39d68 to
8e281a9
Compare
…s for useSuspenseInfiniteQuery - Refactored infinite query tests to use a unified options function. - Added type checks for the new `useSuspenseInfiniteQuery` hook. - Improved test structure for better readability and maintainability.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…in useInfiniteQuery and useSuspenseInfiniteQuery - Standardized spacing in deprecated JSDoc comments for clarity. - Reorganized type imports in useSuspenseInfiniteQuery for better readability.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
…nts across query methods - Unified formatting of deprecated JSDoc comments in QueryCache, QueryClient, and types to enhance clarity. - Updated comments to reflect upcoming changes in method signatures and usage.
There was a problem hiding this comment.
Pull Request Overview
This PR backports v5 infinite query APIs into the v4 codebase, introducing new utilities and marking older overloads as deprecated.
- Added a new
useSuspenseInfiniteQueryhook with built-in suspense and error boundary support - Introduced the
infiniteQueryOptionshelper for building infinite query option objects - Updated deprecation messages on various
useQueryanduseInfiniteQueryoverloads and consolidated exports
Reviewed Changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react-query/src/useSuspenseInfiniteQuery.ts | Added useSuspenseInfiniteQuery hook |
| packages/react-query/src/useQuery.ts | Expanded deprecation messages on useQuery overloads |
| packages/react-query/src/useInfiniteQuery.ts | Expanded deprecation messages on useInfiniteQuery overloads |
| packages/react-query/src/queryOptions.ts | Wrapped UndefinedInitialDataOptions in WithRequired |
| packages/react-query/src/infiniteQueryOptions.ts | Created infiniteQueryOptions utility |
| packages/react-query/src/index.ts | Exported new hook and options utility |
| packages/react-query/src/tests/useSuspenseInfiniteQuery.types.test.tsx | Added type tests for useSuspenseInfiniteQuery |
| packages/react-query/src/tests/queryOptions.types.test.tsx | Updated queryOptions tests with useQuery |
| packages/react-query/src/tests/infiniteQueryOptions.types.test.tsx | Added type tests for infiniteQueryOptions |
| packages/react-query/src/tests/infiniteQueryOptions.test.tsx | Added runtime test for infiniteQueryOptions |
| packages/query-core/src/types.ts | Consolidated deprecated comments into single lines |
| packages/query-core/src/queryClient.ts | Consolidated deprecated comments into single lines |
| packages/query-core/src/queryCache.ts | Consolidated deprecated comments into single lines |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
packages/react-query/src/useSuspenseInfiniteQuery.ts:44
- [nitpick] Consider adding a JSDoc comment above
useSuspenseInfiniteQueryto explain its purpose, parameters, and return type for better discoverability and maintainability.
export function useSuspenseInfiniteQuery<
packages/react-query/src/__tests__/useSuspenseInfiniteQuery.types.test.tsx
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New Features and Utilities:
infiniteQueryOptionsuseSuspenseInfiniteQueryDeprecations:
useQueryanduseInfiniteQueryas deprecated, with a note that they will be removed in the next major version. (packages/react-query/src/useQuery.ts,packages/react-query/src/useInfiniteQuery.ts)Package and Export Updates:
useSuspenseInfiniteQuery,infiniteQueryOptions, and related types from the main package index.