V2: Add overload to make sure createQueryOptions only returns skipToken when could be passed skipToken #469
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
…hen could be passed skipToken Signed-off-by: Paul Sachs <psachs@buf.build>
paul-sachs
changed the title
timostamm
approved these changes
Oct 28, 2024
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.
In order to use createQueryOptions with recent versions of react-query and
useSuspenseQuery, we need to make sure createQueryOptions isn't passingskipTokenas a potential type when the input type couldn't be skipToken. This is because the typings foruseSuspenseQuerynow disallow skipping (which was always the case, just was not reflected in the types.)To fix this, we overload the
createQueryOptionscall to indicate with it's types that it will only return a skipToken when input is a skipToken.