docs(lit-query): add JSDoc to the exported classes, methods, and arrow functions by sukvvon · Pull Request #11885 · TanStack/query

sukvvon · 2026-10-04T03:18:06Z

🎯 Changes

Adds JSDoc (description, @param, @returns) to the exported classes, their non-private methods, and the exported arrow functions that didn't have one:

lit-query: BaseController, hostConnected(), hostDisconnected(), hostUpdate(), destroy(), tryGetQueryClient(), getQueryClient(), setResult(), current, connectedState, queueUpdate(), QueryObserverResultTracker, reset(), update()

None of these are part of the generated reference docs.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

…w functions

changeset-bot · 2026-10-04T03:18:10Z

⚠️ No Changeset found

Latest commit: a50e152

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2026-10-04T03:18:15Z

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: 421f092a-ee90-4b86-9f40-5a1eb25fb5cc

📥 Commits

Reviewing files that changed from the base of the PR and between 51b43f8 and a50e152.

📒 Files selected for processing (2)

packages/lit-query/src/controllers/BaseController.ts
packages/lit-query/src/queryObserverResultTracker.ts

Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

nx-cloud · 2026-10-04T03:18:50Z

View your CI Pipeline Execution ↗ for commit a50e152

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

☁️ Nx Cloud last updated this comment at 2026-10-04 03:39:50 UTC

github-actions · 2026-10-04T03:19:02Z

🚀 Changeset Version Preview

1 package(s) bumped directly, 24 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.104.1 → 5.104.2	Changeset
`@tanstack/angular-query-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/angular-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/eslint-plugin-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/lit-query`	0.2.26 → 0.2.27	Dependent
`@tanstack/preact-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-async-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-persist-client-core`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-sync-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-next-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/svelte-query`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-devtools`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-persist-client`	6.3.1 → 6.3.2	Dependent
`@tanstack/vue-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/vue-query-devtools`	6.3.1 → 6.3.2	Dependent

pkg-pr-new · 2026-10-04T03:22:48Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11885

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11885

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11885

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: a50e152

github-actions · 2026-10-04T03:22:57Z

size-limit report 📦

Path	Size
react full	11.73 KB (0%)
react minimal	8.58 KB (0%)

docs(lit-query): add JSDoc to the exported classes, methods, and arro…

e72b908

…w functions

sukvvon self-assigned this Oct 4, 2026

Merge branch 'main' into docs/lit-query-jsdoc-members

a50e152

sukvvon merged commit fa539fe into main Oct 4, 2026
9 checks passed

sukvvon deleted the docs/lit-query-jsdoc-members branch October 4, 2026 04:04

Navigation Menu

Uh oh!

docs(lit-query): add JSDoc to the exported classes, methods, and arrow functions - #11885

docs(lit-query): add JSDoc to the exported classes, methods, and arrow functions#11885
sukvvon merged 2 commits into
mainfrom
docs/lit-query-jsdoc-members

sukvvon commented Oct 4, 2026

Uh oh!

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

Review limit reached

Uh oh!

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

sukvvon commented Oct 4, 2026

🎯 Changes

✅ Checklist

🚀 Release Impact

Uh oh!

changeset-bot Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review limit reached

Uh oh!

nx-cloud Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

changeset-bot Bot commented Oct 4, 2026 •

edited

Loading

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

pkg-pr-new Bot commented Oct 4, 2026 •

edited

Loading