Skip to content

docs: fix type definition errors in useQuery options#9596

Merged
manudeli merged 2 commits intoTanStack:mainfrom
wo-o29:docs/fix-usequery-type-definitions
Aug 30, 2025
Merged

docs: fix type definition errors in useQuery options#9596
manudeli merged 2 commits intoTanStack:mainfrom
wo-o29:docs/fix-usequery-type-definitions

Conversation

@wo-o29
Copy link
Contributor

@wo-o29 wo-o29 commented Aug 26, 2025 •
edited by coderabbitai bot
Loading

Summary

This PR fixes several type definition issues in the useQuery documentation for better accuracy and consistency.

Changes

  1. Fix union type error

    • Before 
      - staleTime: number | 'static' ((query: Query) => number | 'static')
    • After 
      - staleTime: number | 'static' | ((query: Query) => number | 'static')
    • Reason: Added missing union separator | before the function type.

  2. Fix parameter separator error

    • Before 
      - placeholderData: TData | (previousValue: TData | undefined; previousQuery: Query | undefined,) => TData
    • After 
      - placeholderData: TData | (previousValue: TData | undefined, previousQuery: Query | undefined) => TData
    • Reason: Corrected parameter separator (; → ,) and removed redundant trailing comma in function parameters.

  3. Remove unnecessary parenthesis

    • Before 
      - structuralSharing: boolean | (oldData: unknown | undefined, newData: unknown) => unknown)
    • After 
      - structuralSharing: boolean | (oldData: unknown | undefined, newData: unknown) => unknown
    • Reason: Removed extra closing parenthesis for correct syntax.

Why

  • Corrects syntax issues in type definitions.
  • Ensures documentation matches actual useQuery implementation.
  • Improves readability and avoids confusion for developers referencing the docs.

Summary by CodeRabbit

  • Documentation
    • Updated useQuery Options docs to clarify accepted types and signatures.
    • staleTime now documented to accept a function as well as a number or 'static'.
    • placeholderData signature corrected to a single function with clearly named parameters.
    • structuralSharing punctuation fixed to reflect the intended boolean or function type.
    • queryClient option formatting corrected by removing an extraneous comma.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 26, 2025 •
edited
Loading

Walkthrough

Documentation for React useQuery options was updated to correct and clarify type signatures for staleTime, placeholderData, structuralSharing, and queryClient. No source or runtime changes are indicated.

Changes

Cohort / File(s) Summary of Changes
React useQuery Docs
docs/framework/react/reference/useQuery.md		 Updated option signatures: added function form to staleTime union; converted placeholderData to a single function type with comma-separated params; fixed structuralSharing trailing parenthesis; removed trailing comma from queryClient type. All edits are documentation-only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my ears at types made neat,
Commas hopped out, parens complete.
Stale time can dance, a function too—
Placeholders glide in tidy view.
With docs aligned, I thump in cheer:
The path is clear, no bugs to fear! 🥕✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 26, 2025
coderabbitai[bot]
coderabbitai bot reviewed Aug 26, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/framework/react/reference/useQuery.md (1)

162-167: Align structuralSharing docs with the generic TData signature

Verified that the core implementation in packages/query-core/src/utils.ts uses the generic TData for both input and return values of the structural sharing function (see lines 364–366), so the documentation should reflect that for consistency and precision.

Attention in:

  • docs/framework/react/reference/useQuery.md (around lines 162–167)

Apply this optional refactor:

- `structuralSharing: boolean | (oldData: unknown | undefined, newData: unknown) => unknown`
+ `structuralSharing: boolean | (oldData: TData | undefined, newData: TData) => TData`
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a1b1279 and 0192ae9.

📒 Files selected for processing (1)
  • docs/framework/react/reference/useQuery.md (3 hunks)
🔇 Additional comments (3)
docs/framework/react/reference/useQuery.md (3)

94-101: Correct union fix for staleTime.

Adding the missing union separator before the function type is correct and matches the narrative below that allows a function and the 'static' literal.

157-162: placeholderData function signature separator is now correct.

Replacing the parameter semicolon with a comma and removing the trailing comma resolves the TS syntax issue and aligns with the described semantics.

181-182: Trailing comma removal for queryClient param is correct.

This yields a valid, idiomatic optional parameter listing in the docs.

@bndchris
Copy link

bndchris commented Aug 29, 2025

That's a great opinion!

@nx-cloud
Copy link

nx-cloud bot commented Aug 30, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit fef85e9

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 58s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-08-30 05:31:40 UTC

manudeli
manudeli approved these changes Aug 30, 2025
View reviewed changes
Copy link
Collaborator

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

👀🦅👍

@pkg-pr-new
Copy link

pkg-pr-new bot commented Aug 30, 2025

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@9596

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9596

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9596

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9596

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9596

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9596

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9596

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9596

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9596

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9596

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9596

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9596

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9596

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9596

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9596

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9596

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9596

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9596

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9596

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9596

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9596

commit: fef85e9

@manudeli manudeli merged commit 54efe22 into TanStack:main Aug 30, 2025
6 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 5, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@manudeli manudeli manudeli approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@wo-o29 @bndchris @manudeli