docs(query-core): add JSDoc for shared option and registry types - #11552
Merged
Merged
Conversation
Contributor
|
Important Review skippedToo many files! This PR contains 665 files, which is 365 over the limit of 300. To get a review, reduce the PR to 300 files or fewer by splitting it into smaller PRs or changing its base branch. Usage-priced reviews support at most 300 files. ⚙️ Run configurationConfiguration used: Repository: TanStack/query/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (665)
You can disable this status message by setting the 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 a68c11f
☁️ 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
Ten shared types in
query-corehad no JSDoc, so their generated reference pages rendered with no description at all — and because every adapter re-exportsquery-core, each gap was duplicated across all 7 framework docs.This adds a summary to each of them in
packages/query-core/src/types.ts:RegisterDefaultErrorError; overridden withdefaultErrorQueryKey/MutationKeyReadonlyArray<unknown>; overridden withqueryKey/mutationKeyQueryMeta/MutationMetaRecord<string, unknown>; wheremetacan be read back fromInfiniteDatapagesandpageParamsare index-alignedMutationScopeidruns in serial, waiting inisPaused: true; unscoped mutations run in parallelCancelOptionsCancelledErrorthe cancelled fetch rejects withSetDataOptionsupdatedAtoverrides the timestamp staleness is measured fromEach description was written against the implementation rather than restated from the type signature:
MutationScopematchesMutationCache.canRun()/runNext()and the existing Mutation Scopes guide, including theisPaused: truewait state.InfiniteDataalignment followsinfiniteQueryBehavior.ts, which appends topagesandpageParamstogether.QueryMeta/MutationMetareachability was checked on all three paths:queryFn(Query#fetchbuilds the context withmeta),mutationFn(MutationFunctionContext), and cache-level callbacks (MutationCacheConfigreceives the context;QueryCacheConfigreceives the query, whosemetagetter is public).SetDataOptionsfollowsdataUpdatedAt ?? Date.now()in the success dispatch.CancelOptionsreuses the wording already onCancelledError.Some of these pages render their signature as
type MutationScope = object, so the prose is the only description the page carries.The
Registerexample uses@tanstack/react-query, with the surrounding text listing every adapter module by name —@tanstack/angular-query-experimentalin particular isn't guessable. Augmenting@tanstack/query-corealso works and covers every adapter at once; both forms were verified to type-check.Generated docs
Regenerating with
pnpm run generate-docstouches 664 files, but only 70 are content changes — the pages that gained a description. The other 594 areDefined in:line-number shifts caused by the 57 added source lines.Pages rendering with no description at all: 224 → 154.
✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact