docs: add missing import type for TableMeta module declaration
Update TableMeta module declaration with the import statement to match ColumnMeta module declaration.
For reference, see #4157 and #4104.
Summary by CodeRabbit
- Documentation
- Added a TypeScript example showing how to extend table metadata via declaration merging, helping developers add custom properties in strongly typed projects.
- Clarified usage notes and the import pattern to ensure type augmentation is recognized by TypeScript.
- No behavioral or API changes to the library; this update only improves developer guidance.
Walkthrough
Updated 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
| Cohort / File(s) | Summary of Changes |
|---|---|
Docs: TS declaration merging exampledocs/api/core/table.md |
Added code snippet showing how to augment declare module '@tanstack/table-core' to extend TableMeta<TData extends RowData> with foo: string. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks (3 passed)
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title Check | ✅ Passed | The title succinctly describes the primary change of adding a missing import to the TableMeta module declaration in the documentation and clearly signals that it is a docs update. It directly reflects the main intent of the pull request without extraneous details or ambiguous phrasing. |
| Description Check | ✅ Passed | The description specifically outlines the update to the TableMeta module declaration documentation and references relevant discussion threads for context, making it clearly related to the changeset. It explains what is being updated and why without veering off-topic or remaining overly vague. |
| Docstring Coverage | ✅ Passed | No functions found in the changes. Docstring coverage check skipped. |
Poem
A rabbit taps keys with careful delight,
Adds “foo” to TableMeta—oh what a sight! 🐇
Docs now declare, with modules in tune,
TypeScript extends like a silver balloon.
Hop, merge, compile—everything right!
[!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.
- Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
- Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.
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
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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 @coderabbitai help to get the list of available commands and usage tips.