Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better typesafety for useInfiniteQuery #2126

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

patrickariel
Copy link

Changes

Makes pageParamName typesafe and required. This PR also removes the fallbacks for pageParamName and pageParam, because they shouldn't have default values in the first place (and they're also no longer needed).

The should use custom cursor params test is also removed, because I believe that it shouldn't be allowed now that the param is typesafe. Users can always cast the type if they think the schema isn't right.

How to Review

Most of the changes here are type-level. I'm still not very familiar with the type utilities, so if there are any mistakes let me know.

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@patrickariel patrickariel requested a review from a team as a code owner January 28, 2025 10:49
Copy link

netlify bot commented Jan 28, 2025

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 565f502

Copy link

changeset-bot bot commented Jan 28, 2025

⚠️ No Changeset found

Latest commit: 565f502

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@minchodang
Copy link

Yes, I agree with this PR.
Initially, when I looked at the design of useInfiniteQuery, the pageParamName contains cursor by default.
So, when I tested it, queryParams automatically contains cursor on default request.

@htunnicliff htunnicliff removed their request for review January 28, 2025 16:46
@@ -947,6 +948,7 @@ describe("client", () => {
{
getNextPageParam: (lastPage) => lastPage.nextPage,
initialPageParam: 0,
pageParamName: "cursor",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe here we could use a different param name other than the default one?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, not sure what you mean by "the default one". The schema only provides cursor and limit as parameters, so any other param name here will trigger a type error (due to the changes in this PR). Or are you suggesting a separate schema for the second test?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants