Skip to content

chore: update type tests to use new query methods, types #11345

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

Open
DogPawHat wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: update type tests to use new query methods, types #11345

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
73ffa9b
chore: update type tests to use new query methods, types
DogPawHat Aug 31, 2026
56b1fe4
Merge branch 'main' into simplifed-query-methods/internal-tests-types
DogPawHat Aug 31, 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 packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,12 @@ describe('infiniteQueryOptions', () => {
// @ts-expect-error cannot pass infinite options to non-infinite query functions
injectQuery(() => options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.query(options),
)

// deprecated methods below to be removed next major version
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.ensureQueryData(options),
Expand Down
6 changes: 6 additions & 0 deletions packages/preact-query/src/__tests__/infiniteQueryOptions.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,12 @@ describe('infiniteQueryOptions', () => {
// @ts-expect-error cannot pass infinite options to non-infinite query functions
useQuery(options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.query(options),
)

// deprecated methods below to be removed next major version
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.ensureQueryData(options),
Expand Down
38 changes: 12 additions & 26 deletions packages/query-core/src/__tests__/queryClient.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ import type {
DataTag,
DefaultError,
DefaultedQueryObserverOptions,
EnsureQueryDataOptions,
FetchInfiniteQueryOptions,
InfiniteData,
InfiniteQueryExecuteOptions,
MutationOptions,
OmitKeyof,
QueryExecuteOptions,
QueryKey,
QueryObserverOptions,
} from '../types'
Expand Down Expand Up @@ -349,6 +348,10 @@ describe('fully typed usage', () => {
// Construct typed arguments
//

const queryOptions: QueryExecuteOptions<TData, TError> = {
queryKey: ['key', 'query'],
}

const infiniteQueryOptions: InfiniteQueryExecuteOptions<
TData,
TError,
Expand All @@ -363,21 +366,6 @@ describe('fully typed usage', () => {
initialPageParam: 0,
}

const queryOptions: EnsureQueryDataOptions<TData, TError> = {
queryKey: ['key', 'query'],
}

const fetchInfiniteQueryOptions: FetchInfiniteQueryOptions<TData, TError> =
{
queryKey: ['key', 'infinite'],
pages: 5,
getNextPageParam: (lastPage) => {
expectTypeOf(lastPage).toEqualTypeOf<TData>()
return 0
},
initialPageParam: 0,
}

const mutationOptions: MutationOptions<TData, TError> = {}

const queryFilters: QueryFilters<DataTag<QueryKey, TData, TError>> = {
Expand Down Expand Up @@ -458,19 +446,17 @@ describe('fully typed usage', () => {

queryClient.prefetchQuery(queryOptions)

const fetchInfiniteQueryResult = await queryClient.fetchInfiniteQuery(
fetchInfiniteQueryOptions,
)
const fetchInfiniteQueryResult =
await queryClient.fetchInfiniteQuery(infiniteQueryOptions)
expectTypeOf(fetchInfiniteQueryResult).toEqualTypeOf<
InfiniteData<TData, unknown>
>()

const infiniteQuery = await queryClient.infiniteQuery(infiniteQueryOptions)
expectTypeOf(infiniteQuery).toEqualTypeOf<InfiniteData<TData, unknown>>()

const infiniteQueryData = await queryClient.ensureInfiniteQueryData(
fetchInfiniteQueryOptions,
)
const infiniteQueryData =
await queryClient.ensureInfiniteQueryData(infiniteQueryOptions)
expectTypeOf(infiniteQueryData).toEqualTypeOf<
InfiniteData<TData, unknown>
>()
Expand Down Expand Up @@ -508,7 +494,7 @@ describe('fully typed usage', () => {
queryClient.cancelQueries(queryFilters)
queryClient.invalidateQueries(queryFilters)
queryClient.refetchQueries(queryFilters)
queryClient.prefetchInfiniteQuery(fetchInfiniteQueryOptions)
queryClient.prefetchInfiniteQuery(infiniteQueryOptions)
queryClient.setQueryDefaults(filterKey, {} as any)
queryClient.getMutationDefaults(mutationKey)
})
Expand All @@ -520,10 +506,10 @@ describe('fully typed usage', () => {
// Construct typed arguments
//

const queryOptions: EnsureQueryDataOptions = {
const queryOptions: QueryExecuteOptions = {
queryKey: ['key'] as any,
}
const fetchInfiniteQueryOptions: FetchInfiniteQueryOptions = {
const fetchInfiniteQueryOptions: InfiniteQueryExecuteOptions = {
queryKey: ['key'] as any,
pages: 5,
getNextPageParam: (lastPage) => {
Expand Down
6 changes: 6 additions & 0 deletions packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,12 @@ describe('infiniteQueryOptions', () => {
// @ts-expect-error cannot pass infinite options to non-infinite query functions
useQuery(options),
)
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.query(options),
)

// deprecated methods to be removed in v6
assertType(
// @ts-expect-error cannot pass infinite options to non-infinite query functions
queryClient.ensureQueryData(options),
Expand Down