docs(react-query): add missing errorUpdateCount to useQuery return signature#11041
Open
KangaZero wants to merge 2 commits into
Open
docs(react-query): add missing errorUpdateCount to useQuery return signature#11041KangaZero wants to merge 2 commits into
KangaZero wants to merge 2 commits into
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThe React and Solid ChangesuseQuery documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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
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.
Summary
errorUpdateCountis fully documented in the Returns section of theuseQueryreference pages but is missing from the destructuring block at the top of the page — the first thing a reader sees when scanning the API.Affected files:
docs/framework/react/reference/useQuery.mddocs/framework/solid/reference/useQuery.mdThe source of truth in
packages/query-core/src/types.ts(line 655) placeserrorUpdateCountbetweenfailureReasonand thefetchStatusblock, which is what this fix reflects.failureReason, + errorUpdateCount, fetchStatus,How did you test this change?
Documentation-only change — no runtime behavior affected, no tests needed. Verified by:
packages/query-core/src/types.tsline 655, which defineserrorUpdateCount: numberbetweenfailureReasonand thefetchStatus-related fields.errorUpdateCountis already present and correctly documented in the Returns section of both files (lines 249 and 366 respectively) — it was only absent from the top-of-page destructuring example.Summary by CodeRabbit
useQuerydocumentation examples to destructure and displayerrorUpdateCountfrom the hook’s return value.