Skip to content

fix({react,preact}-query): default 'TData' of infinite query options to 'InfiniteData'#11147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TkDodo merged 2 commits into from
Aug 18, 2026
Merged

fix({react,preact}-query): default 'TData' of infinite query options to 'InfiniteData' #11147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f4fd04
fix({react,preact}-query): default 'TData' of infinite query options …
lazerg Aug 6, 2026
877090f
Merge branch 'main' into fix/issue-11143-infinite-query-options-tdata
TkDodo Aug 18, 2026
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
6 changes: 6 additions & 0 deletions .changeset/gentle-moons-shave.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@tanstack/react-query': patch
'@tanstack/preact-query': patch
---

Default `TData` of `UseInfiniteQueryOptions` and `UseSuspenseInfiniteQueryOptions` to `InfiniteData<TQueryFnData>` so it matches the hook generics.
17 changes: 17 additions & 0 deletions packages/preact-query/src/__tests__/useInfiniteQuery.test-d.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { InfiniteData } from '@tanstack/query-core'
import { queryKey } from '@tanstack/query-test-utils'
import { describe, expectTypeOf, it } from 'vitest'

import type { UseInfiniteQueryOptions } from '../types'
import { useInfiniteQuery } from '../useInfiniteQuery'

describe('pageParam', () => {
Expand DownExpand Up@@ -142,3 +143,19 @@ describe('error booleans', () => {
expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
})
})

describe('UseInfiniteQueryOptions', () => {
it('should default TData to InfiniteData<TQueryFnData>', () => {
const options: UseInfiniteQueryOptions<number, Error> = {
queryKey: queryKey(),
queryFn: () => 5,
initialPageParam: 1,
getNextPageParam: () => undefined,
}
const infiniteQuery = useInfiniteQuery(options)

expectTypeOf(infiniteQuery.data).toEqualTypeOf<
InfiniteData<number, unknown> | undefined
>()
})
})
13 changes: 13 additions & 0 deletions packages/preact-query/src/__tests__/useSuspenseInfiniteQuery.test-d.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { InfiniteData } from '@tanstack/query-core'
import { queryKey } from '@tanstack/query-test-utils'
import { assertType, describe, expectTypeOf, it } from 'vitest'

import type { UseSuspenseInfiniteQueryOptions } from '../types'
import { useSuspenseInfiniteQuery } from '../useSuspenseInfiniteQuery'

describe('useSuspenseInfiniteQuery', () => {
Expand DownExpand Up@@ -82,6 +83,18 @@ describe('useSuspenseInfiniteQuery', () => {
)
})

it('should default TData of UseSuspenseInfiniteQueryOptions to InfiniteData<TQueryFnData>', () => {
const options: UseSuspenseInfiniteQueryOptions<number, Error> = {
queryKey: queryKey(),
queryFn: () => Promise.resolve(5),
initialPageParam: 1,
getNextPageParam: () => 1,
}
const { data } = useSuspenseInfiniteQuery(options)

expectTypeOf(data).toEqualTypeOf<InfiniteData<number, unknown>>()
})

it('should not return isPlaceholderData', () => {
const query = useSuspenseInfiniteQuery({
queryKey: queryKey(),
Expand Down
5 changes: 3 additions & 2 deletions packages/preact-query/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type {
DefinedQueryObserverResult,
DistributiveOmit,
FetchQueryOptions,
InfiniteData,
InfiniteQueryObserverOptions,
InfiniteQueryObserverResult,
MutateFunction,
Expand DownExpand Up@@ -102,7 +103,7 @@ export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
export interface UseInfiniteQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TData = InfiniteData<TQueryFnData>,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends OmitKeyof<
Expand All@@ -127,7 +128,7 @@ export type AnyUseSuspenseInfiniteQueryOptions =
export interface UseSuspenseInfiniteQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TData = InfiniteData<TQueryFnData>,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends OmitKeyof<
Expand Down
17 changes: 17 additions & 0 deletions packages/react-query/src/__tests__/useInfiniteQuery.test-d.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { QueryClient } from '@tanstack/query-core'
import { queryKey } from '@tanstack/query-test-utils'
import { useInfiniteQuery } from '../useInfiniteQuery'
import type { InfiniteData } from '@tanstack/query-core'
import type { UseInfiniteQueryOptions } from '../types'

describe('pageParam', () => {
it('initialPageParam should define type of param passed to queryFunctionContext', () => {
Expand DownExpand Up@@ -141,3 +142,19 @@ describe('error booleans', () => {
expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
})
})

describe('UseInfiniteQueryOptions', () => {
it('should default TData to InfiniteData<TQueryFnData>', () => {
const options: UseInfiniteQueryOptions<number, Error> = {
queryKey: queryKey(),
queryFn: () => 5,
initialPageParam: 1,
getNextPageParam: () => undefined,
}
const infiniteQuery = useInfiniteQuery(options)

expectTypeOf(infiniteQuery.data).toEqualTypeOf<
InfiniteData<number, unknown> | undefined
>()
})
})
13 changes: 13 additions & 0 deletions packages/react-query/src/__tests__/useSuspenseInfiniteQuery.test-d.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { skipToken } from '@tanstack/query-core'
import { queryKey } from '@tanstack/query-test-utils'
import { useSuspenseInfiniteQuery } from '../useSuspenseInfiniteQuery'
import type { InfiniteData } from '@tanstack/query-core'
import type { UseSuspenseInfiniteQueryOptions } from '../types'

describe('useSuspenseInfiniteQuery', () => {
it('should always have data defined', () => {
Expand DownExpand Up@@ -81,6 +82,18 @@ describe('useSuspenseInfiniteQuery', () => {
)
})

it('should default TData of UseSuspenseInfiniteQueryOptions to InfiniteData<TQueryFnData>', () => {
const options: UseSuspenseInfiniteQueryOptions<number, Error> = {
queryKey: queryKey(),
queryFn: () => Promise.resolve(5),
initialPageParam: 1,
getNextPageParam: () => 1,
}
const { data } = useSuspenseInfiniteQuery(options)

expectTypeOf(data).toEqualTypeOf<InfiniteData<number, unknown>>()
})

it('should not return isPlaceholderData', () => {
const query = useSuspenseInfiniteQuery({
queryKey: queryKey(),
Expand Down
5 changes: 3 additions & 2 deletions packages/react-query/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import type {
DefinedQueryObserverResult,
DistributiveOmit,
FetchQueryOptions,
InfiniteData,
InfiniteQueryObserverOptions,
InfiniteQueryObserverResult,
MutateFunction,
Expand DownExpand Up@@ -103,7 +104,7 @@ export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
export interface UseInfiniteQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TData = InfiniteData<TQueryFnData>,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends OmitKeyof<
Expand All@@ -128,7 +129,7 @@ export type AnyUseSuspenseInfiniteQueryOptions =
export interface UseSuspenseInfiniteQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TData = InfiniteData<TQueryFnData>,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends OmitKeyof<
Expand Down
Loading