Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/orange-boxes-visit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@tanstack/query-core": patch
---

fix(types): allow QueryFilters union with different lengths
13 changes: 13 additions & 0 deletions packages/query-core/src/__tests__/utils.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,19 @@ describe('QueryFilters', () => {
>()
})

// we test that there are not type errors here
// eslint-disable-next-line vitest/expect-expect
it('should work with unions of different lengths', () => {
type Key =
| readonly ['foo']
| readonly ['foo', 'bar']
| readonly ['foo', 'bar', 'baz']

const queryKey: Key = ['foo', 'bar'] as any as Key

new QueryClient().invalidateQueries({ queryKey })
})

it('should error on invalid query keys', () => {
assertType<QueryFilters<readonly ['key', { a: number; b: string }]>>({
// @ts-expect-error cannot pass invalid query key
Expand Down
2 changes: 1 addition & 1 deletion packages/query-core/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export interface QueryFilters<TQueryKey extends QueryKey = QueryKey> {
/**
* Include queries matching this query key
*/
queryKey?: TuplePrefixes<TQueryKey>
queryKey?: TQueryKey | TuplePrefixes<TQueryKey>
/**
* Include or exclude stale queries
*/
Expand Down
Loading