Feat: add infinite query options#2484
Open
minchodang wants to merge 4 commits intoopenapi-ts:mainfrom
Open
Conversation
👷 Deploy request for openapi-ts pending review.Visit the deploys page to approve it
|
|
ddc3d33 to
07aea3a
Compare
…eQueryOptions - Add initialPageParam to UseInfiniteQueryMethod options - Use InferPageParamType<Options> instead of unknown for TPageParam - Clean up unused variables in tests
Author
|
@htunnicliff |
|
Hey, there we are also interested in these updates, can we somehow proceed with this? |
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
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.
Changes
This PR adds the
infiniteQueryOptionshelper method toopenapi-react-query, resolving #2462.What's Added:
infiniteQueryOptionsmethod in the client APIdocs/openapi-react-query/infinite-query-options.mdImplementation Details:
InfiniteQueryOptionsFunctiontype with full type inference forpageParam,InfiniteData, andselectreturn typesinfiniteQueryOptionsreturns ready-to-use options foruseInfiniteQuery,usePrefetchInfiniteQuery,QueryClient.fetchInfiniteQuery, and other infinite query APIspageParamNameoption (defaults to"cursor")queryKeyconvention for consistencyWhy This Matters:
Previously,
openapi-react-queryprovided excellent ergonomics for standard queries throughqueryOptionsanduseQuery, but lacked first-class support for infinite queries. Users had to hand-roll option objects and type definitions for cursor/offset pagination use cases.This addition:
pageParamandInfiniteDataqueryOptionsHow to Review
Implementation: Review the
infiniteQueryOptionsfunction and type definitions inpackages/openapi-react-query/src/index.ts:pageParamviaInferPageParamTypepageParaminto query paramsqueryOptionsimplementationTests: Check test coverage in
packages/openapi-react-query/test/for:getNextPageParam/getPreviousPageParambehavioruseInfiniteQueryDocumentation: Review
docs/openapi-react-query/infinite-query-options.mdfor:query-options.md)useInfiniteQueryandusePrefetchInfiniteQueryNavigation: Verify the new page is properly integrated in
.vitepress/en.tsChecklist
docs/updatedpnpm run update:examplesrun (N/A - only applicable for openapi-typescript)Closes #2462