docs: add missing import type for TableMeta module declaration#6088
docs: add missing import type for TableMeta module declaration#6088AzzouQ wants to merge 1 commit intoTanStack:mainfrom
Conversation
WalkthroughUpdated documentation adds a TypeScript declaration-merging example that augments the TableMeta interface in the @tanstack/table-core module by introducing a foo: string property. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches🧪 Generate unit tests
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 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/api/core/table.md (1)
85-86: Nit: prefer ts fence and a brief noteConsider changing the code fence to
ts(no JSX here) and adding a one-liner explaining that the side-effect import is required for declaration merging to take effect.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/api/core/table.md(1 hunks)
🔇 Additional comments (1)
docs/api/core/table.md (1)
85-86: Correct fix: side-effect import enables module augmentationAdding
import '@tanstack/table-core'ensures thedeclare moduleaugmentation forTableMetais picked up and aligns with theColumnMetadocs. Looks good.
Update TableMeta module declaration with the import statement to match ColumnMeta module declaration.
For reference, see #4157 and #4104.
Summary by CodeRabbit