Commit 9000585
committed
fix: change QueryCollectionMeta to interface for proper extensibility
This commit addresses two critical issues identified in code review:
1. **Fixed double export**: Removed duplicate QueryCollectionMeta export from
the query.ts line in index.ts. QueryCollectionMeta is now only exported
from global.d.ts, which is its canonical source.
2. **Changed from type alias to interface**: Converting QueryCollectionMeta
from a type alias to an interface enables proper TypeScript declaration
merging. This allows users to extend meta with custom properties without
encountering "Subsequent property declarations must have the same type"
errors.
The updated documentation now shows the correct pattern for users to extend
meta:
```typescript
declare module "@tanstack/query-db-collection" {
interface QueryCollectionMeta {
myCustomProperty: string
}
}
```
This is safer than the previous pattern which would have caused users to
collide with the library's own Register.queryMeta augmentation.
Added a type test documenting the extension pattern for future reference.1 parent 7cb3d66 commit 9000585
File tree
3 files changed
+48
-10
lines changed- packages/query-db-collection
- src
- tests
3 files changed
+48
-10
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
16 | | - | |
17 | | - | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
26 | 25 | | |
27 | 26 | | |
28 | 27 | | |
29 | 28 | | |
30 | | - | |
| 29 | + | |
31 | 30 | | |
32 | 31 | | |
33 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
505 | 505 | | |
506 | 506 | | |
507 | 507 | | |
| 508 | + | |
| 509 | + | |
| 510 | + | |
| 511 | + | |
| 512 | + | |
| 513 | + | |
| 514 | + | |
| 515 | + | |
| 516 | + | |
| 517 | + | |
| 518 | + | |
| 519 | + | |
| 520 | + | |
| 521 | + | |
| 522 | + | |
| 523 | + | |
| 524 | + | |
| 525 | + | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
| 533 | + | |
| 534 | + | |
| 535 | + | |
| 536 | + | |
| 537 | + | |
| 538 | + | |
| 539 | + | |
| 540 | + | |
| 541 | + | |
| 542 | + | |
| 543 | + | |
| 544 | + | |
| 545 | + | |
| 546 | + | |
508 | 547 | | |
509 | 548 | | |
0 commit comments