Skip to content
Open
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/tidy-cougars-serve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/query-core': patch
---

fix(query-core): setQueryData updater no longer loses discriminated-union members when spreading a narrowed value
21 changes: 21 additions & 0 deletions packages/query-core/src/__tests__/queryClient.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,27 @@ describe('queryClient', () => {
expectTypeOf(data).toEqualTypeOf<number | undefined>()
})

it('should narrow a discriminated union when spreading the updater value', () => {
type ProbeData =
| { kind: 'a'; value: number; requiredA: number }
| { kind: 'b'; value: number; requiredB: number }
const key = ['probe'] as DataTag<Array<string>, ProbeData>
const queryClient = new QueryClient()

// Regression test for #11795: this call must compile without an
// explicit annotation on `prev`
queryClient.setQueryData(key, (prev) => {
expectTypeOf(prev).toEqualTypeOf<ProbeData | undefined>()
if (!prev || prev.kind !== 'a') return prev
expectTypeOf(prev).toEqualTypeOf<{
kind: 'a'
value: number
requiredA: number
}>()
return { ...prev, value: prev.value + 1 }
})
})

it('should type the value if the key is tagged', () => {
const key = ['key'] as DataTag<Array<string>, number>
const queryClient = new QueryClient()
Expand Down
2 changes: 1 addition & 1 deletion packages/query-core/src/queryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ export class QueryClient {
>(
queryKey: TTaggedQueryKey,
updater: Updater<
NoInfer<TInferredQueryFnData> | undefined,
TInferredQueryFnData | undefined,
NoInfer<TInferredQueryFnData> | undefined
>,
options?: SetDataOptions,
Expand Down