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/fix-persister-infer-when-queryfn-has-parameter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/query-core': patch
---

fix(query-core): allow `persister` to contribute to `TQueryFnData` inference so a `queryFn` that declares a parameter no longer produces a spurious overload mismatch against a typed persister (#7842).
6 changes: 1 addition & 5 deletions packages/query-core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,11 +246,7 @@ export interface QueryOptions<
*/
gcTime?: number
queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam> | SkipToken
persister?: QueryPersister<
NoInfer<TQueryFnData>,
NoInfer<TQueryKey>,
NoInfer<TPageParam>
>
persister?: QueryPersister<TQueryFnData, TQueryKey, TPageParam>
queryHash?: string
queryKey?: TQueryKey
queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand Down
37 changes: 37 additions & 0 deletions packages/react-query/src/__tests__/queryOptions.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import type {
DataTag,
InitialDataFunction,
QueryObserverResult,
QueryPersister,
} from '@tanstack/query-core'

describe('queryOptions', () => {
Expand Down Expand Up @@ -284,4 +285,40 @@ describe('queryOptions', () => {
DataTag<MyQueryKey, number, Error & { myMessage: string }>
>()
})

it('should infer TQueryFnData from persister paired with a queryFn declaring a parameter (#7842)', () => {
const persister = undefined as unknown as QueryPersister<string, any>

const options = queryOptions({
queryKey: ['key'],
queryFn: (_context) => 'hello',
persister,
})

expectTypeOf(options.queryFn!).returns.toEqualTypeOf<
string | Promise<string>
>()
})

it('should still error when persister and queryFn return types genuinely conflict', () => {
const persister = undefined as unknown as QueryPersister<string, any>

assertType(
queryOptions({
queryKey: ['key'],
// @ts-expect-error persister expects string, queryFn returns number
queryFn: () => 42,
persister,
}),
)

assertType(
queryOptions({
queryKey: ['key'],
// @ts-expect-error persister expects string, queryFn with arg returns number
queryFn: (_context) => 42,
persister,
}),
)
})
})
Loading