fix(vue-query): widen 'SkipToken' to 'symbol' so it type-checks inside a whole-options getter - #11427
Draft
sukvvon wants to merge 3 commits into
Draft
fix(vue-query): widen 'SkipToken' to 'symbol' so it type-checks inside a whole-options getter#11427sukvvon wants to merge 3 commits into
sukvvon wants to merge 3 commits into
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit 940dd0d
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview3 package(s) bumped directly, 22 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
Contributor
size-limit report 📦
|
5 tasks
…epts unrelated symbols
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
1 participant
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
useQuery/queryOptions's whole-options getter overload (useQuery(() => ({...}))/queryOptions(() => ({...}))) failed to type-check thequeryFn: cond ? fn : skipTokenpattern shown in their own JSDoc examples.Root cause:
SkipTokenis aunique symbol. When a function has more than one overload and the argument is a getter, TypeScript fails to propagate the contextual type into a ternary inside the getter's body, widening the ternary'sunique symbolbranch to plainsymbol— which no longer matches any overload.This repo already has a fix for the same issue in
useQueries.ts(SkipTokenForUseQueries = symbol, widening the symbol so inference still works even thoughskipTokenisn't treated as immutable). This PR applies the same widening toUseQueryOptions(useQuery.ts) andQueryOptions(queryOptions.ts).Since
QueryOptionsis also the basis ofqueryOptions()'s return type, wideningqueryFnthere would leaksymbolintoQueryClientmethods (fetchQuery,invalidateQueries, etc.) that still expectunique symbol.UndefinedInitialQueryOptionsWithDataTag/DefinedInitialQueryOptionsWithDataTagnarrowqueryFnback withOmitKeyofso the returned options object stays correctly typed.No runtime behavior changes — this is a type-only fix.
useQuery.test-d.ts's@ts-expect-errortest (documenting the previously-broken pattern) is replaced with a realexpectTypeOfassertion confirming it now type-checks correctly.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact