docs(query-core): add JSDoc for 'initialPageParam' - #11551
Merged
Merged
Conversation
Contributor
|
Important Review skippedToo many files! This PR contains 457 files, which is 157 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 (457)
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 7cb40aa
☁️ 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 📦
|
sukvvon
force-pushed
the
docs/initial-page-param-jsdoc
branch
from
September 19, 2026 07:53
7cb40aa to
7c0dad5
Compare
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
InitialPageParamcarries no JSDoc, soinitialPageParam— a required option for every infinite query — renders with an empty description on seven pages per adapter:initialPageParamTPageParamThis adds a comment for it in
query-core, filling 34 empty description cells across the generated reference.The wording follows
getNextPageParamandgetPreviousPageParam, which sit next to it inInfiniteQueryPageParamsOptionsand are already documented.Why the last sentence is there
The deleted v4 page described this option as "the default page param to use when fetching the first page". That is true but incomplete:
infiniteQueryBehaviorreadsoldPageParams[0] ?? options.initialPageParam, so once the query holds a page, the stored param wins andinitialPageParamis not consulted. Only the first page param is reused that way — subsequent pages are recomputed throughgetNextPageParam— so the comment says "that page's own param" rather than implying every stored param is replayed.Each claim was checked against the implementation:
currentPage === 0 ? (oldPageParams[0] ?? options.initialPageParam) : …queryFnaspageParampageParam: paramin the query function contextgetNextPageParamon refetch,getPreviousPageParamwhen paging backwardInitialPageParamis extended solely by the infinite query option typesNote on the diff size
456 files change, but only 27 of them change content. The other 429 are
Defined in …types.ts#L…links shifting because the comment adds lines totypes.ts.initialPageParamstill renders empty onQueryExecuteOptions, where it is re-declared asinitialPageParam?: neverto reject the option rather than inherit it. There is no value to describe there, so it is left alone.Verification
initialPageParam: 41 → 7 (all remaining ones are theneverre-declaration above)pnpm --filter @tanstack/query-core run test:typespasses on TS 5.6 through 7.0The source change is comments only; no type or runtime behaviour changes.
✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact