fix(vue-query): preserve queryOptions object type to avoid property loss

[Sigmabrogz]

🎯 Changes

Fixes #7892

There's a discrepancy between the return type of queryOptions in vue-query and react-query. When wrapping the options via queryOptions, properties like queryFn are lost on the returned type because UndefinedInitialQueryOptions is evaluated as a MaybeRef<...> union.

This fix introduces TOptions as a generic parameter that extends the base options, ensuring that the literal object passed in is preserved in the return type without being collapsed into the ref union.

✅ Checklist

• I have followed the steps in the Contributing guide.
• I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

• This change affects published code, and I have generated a changeset.
• This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

• Refactor
  • Query option types now preserve more precise type information, improving IDE autocomplete accuracy and type validation. Developers benefit from better type hints and earlier error detection when configuring and using queries.

[coderabbitai]

📝 Walkthrough

Walkthrough

The queryOptions function signature is enhanced with a new generic parameter TOptions to preserve the precise shape of input options in the return type, enabling TypeScript to properly infer all properties instead of narrowing the type to only queryKey and initialData.

Changes

Cohort / File(s)	Summary
Type Signature Enhancement packages/vue-query/src/queryOptions.ts	Added generic parameter TOptions to both overloads of queryOptions, constraining it to either DefinedInitialQueryOptions or UndefinedInitialQueryOptions. The return type now preserves the full shape of the input options by intersecting TOptions with the queryKey tag, enabling proper TypeScript inference of properties like queryFn and placeholderData.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A rabbit's tale of types so fine,
Where options dance in perfect line,
Generic parameters take their place,
TypeScript grins with happy face—
All properties preserved with grace! 🥕✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: introducing generic parameter preservation for queryOptions to fix property loss in the returned type.
Linked Issues check	✅ Passed	The code changes directly address issue #7892 by introducing the TOptions generic parameter to preserve the literal options object type in queryOptions return type.
Out of Scope Changes check	✅ Passed	All changes are scoped to fixing the queryOptions type preservation issue in vue-query; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The pull request description includes all required sections: a detailed explanation of changes, link to related issue #7892, completed checklist items, and confirmation of changeset generation for published code.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🤖 Automated account detected

@Sigmabrogz has been flagged as a likely automated account.

Classification: automation (score: 45)

Signal	Points	Detail
Frequent repository creation	+25	9 repositories created in a short timeframe (within 24 hours)
24/7 activity pattern	+30	Active 20/24 hours, 2h max rest, 9.2 events/hour

_{Analyzed 183 public events via voight-kampff-test}

[Sigmabrogz]

Closing this PR as the automated anti-bot pipeline has blocked the contribution. This was an autonomous OSS agent patch. Feel free to adopt the fix!

[TkDodo]

This was an autonomous OSS agent patch

How about disclosing that upfront 🤨?

I’m not against the fix if its good. But please add a test case that fails on main that shows your fix does what it claims.