docs: Generate API reference documentation for core database classes and functions#1286
Merged
KyleAMathews merged 2 commits intomainfrom Feb 23, 2026
Merged
docs: Generate API reference documentation for core database classes and functions#1286KyleAMathews merged 2 commits intomainfrom
KyleAMathews merged 2 commits intomainfrom
Conversation
The db package's tsconfig.docs.json included "tests" in its include array, causing TypeScript errors that prevented TypeDoc from generating the core API reference documentation. Fixed by changing include to only "src" and adding explicit path mappings, consistent with all other package docs configs. https://claude.ai/code/session_0141NF2Zm7Q2GPt3CU8NKcNT
Auto-generated output from running generate-docs script. Includes minor formatting updates to existing reference docs for framework and collection packages. https://claude.ai/code/session_0141NF2Zm7Q2GPt3CU8NKcNT
|
KyleAMathews
commented
Feb 23, 2026
Collaborator
Author
KyleAMathews
left a comment
KyleAMathews
left a comment
There was a problem hiding this comment.
This is what was missing in packages/db/tsconfig.docs.json
"compilerOptions": {
"paths": {
"@tanstack/store": ["../store/src"],
"@tanstack/db-ivm": ["../db-ivm/src"]
}
},
"include": ["src"]
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Contributor
|
Size Change: 0 B Total Size: 92.1 kB ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 3.7 kB ℹ️ View Unchanged
|
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
2 participants
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
This PR adds comprehensive API reference documentation for the TanStack DB core package. The changes include:
CollectionImpl,BaseQueryBuilder,BaseIndex,BTreeIndex,IndexProxy, andLazyIndexWrapperAggregate,Func,CollectionRef,QueryRef,PropRef,Value), interfaces (QueryIR,JoinClause), type aliases, and utility functionsThese documentation files are auto-generated from TypeScript source code and provide developers with detailed API information including:
✅ Checklist
📝 Notes
All documentation files are generated from the TypeScript source code and should not be manually edited. Updates to these docs should be made by regenerating them from the source code.
https://claude.ai/code/session_0141NF2Zm7Q2GPt3CU8NKcNT