docs(svelte-query): call 'useIsMutating' a function instead of a hook - #11559
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: TanStack/query/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthroughThe change replaces “optional hook” with “optional function” in the ChangesuseIsMutating terminology
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
|
View your CI Pipeline Execution ↗ for commit c1680c5
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview1 package(s) bumped directly, 24 bumped as dependents. 🟩 Patch bumps
|
Contributor
size-limit report 📦
|
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
#11553 gave
useIsFetchingthe summary shared with the React and Preact adapters, writing "hook" as "function" to match this adapter. Its siblinguseIsMutatingcarries the near-identical sentence and kept "hook", so the two now contradict each other inside one package:This changes that one word.
"hook" is React and Preact terminology for these APIs. Svelte doesn't use it — its reactivity APIs are runes, and the only "hook" in
svelte's own type definitions refers topreprocessbuild hooks. "function" is what this package already says elsewhere:createMutationis the function for that.Not touched
useMutationState.svelte.tssays mutations "were created by a different component or hook instance". There "hook" means a call site rather than an API category, so "function instance" would read wrong; left as is.query-coredescribes "a framework hook likeuseQuery" inQuery,MutationandMutationObserver. That's a framework-agnostic package referring to React/Vue/etc. generically and is correct as written, so those three class pages still contain the word after this PR.Generated docs
pnpm run generate-docsupdates the one corresponding page.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit
useIsMutatingis an optional function returning a reactive value, rather than an optional hook.