From 73ffa9b067cc9a720ce098e12f4d5783af33ab9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Curley?= Date: Mon, 31 Aug 2026 12:32:46 +0100 Subject: [PATCH] chore: update type tests to use new query methods, types --- .../infinite-query-options.test-d.ts | 6 +++ .../__tests__/infiniteQueryOptions.test-d.tsx | 6 +++ .../src/__tests__/queryClient.test-d.tsx | 38 ++++++------------- .../__tests__/infiniteQueryOptions.test-d.tsx | 6 +++ 4 files changed, 30 insertions(+), 26 deletions(-) diff --git a/packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts b/packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts index e9f41ed3b6..ab5d276762 100644 --- a/packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts +++ b/packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts @@ -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), diff --git a/packages/preact-query/src/__tests__/infiniteQueryOptions.test-d.tsx b/packages/preact-query/src/__tests__/infiniteQueryOptions.test-d.tsx index 563e7a6911..93f8955369 100644 --- a/packages/preact-query/src/__tests__/infiniteQueryOptions.test-d.tsx +++ b/packages/preact-query/src/__tests__/infiniteQueryOptions.test-d.tsx @@ -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), diff --git a/packages/query-core/src/__tests__/queryClient.test-d.tsx b/packages/query-core/src/__tests__/queryClient.test-d.tsx index 026539f26b..242f2b8574 100644 --- a/packages/query-core/src/__tests__/queryClient.test-d.tsx +++ b/packages/query-core/src/__tests__/queryClient.test-d.tsx @@ -9,12 +9,11 @@ import type { DataTag, DefaultError, DefaultedQueryObserverOptions, - EnsureQueryDataOptions, - FetchInfiniteQueryOptions, InfiniteData, InfiniteQueryExecuteOptions, MutationOptions, OmitKeyof, + QueryExecuteOptions, QueryKey, QueryObserverOptions, } from '../types' @@ -349,6 +348,10 @@ describe('fully typed usage', () => { // Construct typed arguments // + const queryOptions: QueryExecuteOptions = { + queryKey: ['key', 'query'], + } + const infiniteQueryOptions: InfiniteQueryExecuteOptions< TData, TError, @@ -363,21 +366,6 @@ describe('fully typed usage', () => { initialPageParam: 0, } - const queryOptions: EnsureQueryDataOptions = { - queryKey: ['key', 'query'], - } - - const fetchInfiniteQueryOptions: FetchInfiniteQueryOptions = - { - queryKey: ['key', 'infinite'], - pages: 5, - getNextPageParam: (lastPage) => { - expectTypeOf(lastPage).toEqualTypeOf() - return 0 - }, - initialPageParam: 0, - } - const mutationOptions: MutationOptions = {} const queryFilters: QueryFilters> = { @@ -458,9 +446,8 @@ describe('fully typed usage', () => { queryClient.prefetchQuery(queryOptions) - const fetchInfiniteQueryResult = await queryClient.fetchInfiniteQuery( - fetchInfiniteQueryOptions, - ) + const fetchInfiniteQueryResult = + await queryClient.fetchInfiniteQuery(infiniteQueryOptions) expectTypeOf(fetchInfiniteQueryResult).toEqualTypeOf< InfiniteData >() @@ -468,9 +455,8 @@ describe('fully typed usage', () => { const infiniteQuery = await queryClient.infiniteQuery(infiniteQueryOptions) expectTypeOf(infiniteQuery).toEqualTypeOf>() - const infiniteQueryData = await queryClient.ensureInfiniteQueryData( - fetchInfiniteQueryOptions, - ) + const infiniteQueryData = + await queryClient.ensureInfiniteQueryData(infiniteQueryOptions) expectTypeOf(infiniteQueryData).toEqualTypeOf< InfiniteData >() @@ -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) }) @@ -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) => { diff --git a/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx b/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx index b0d233703a..ce3d6cdb10 100644 --- a/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx +++ b/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx @@ -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),