Skip to content

init query rename and delegation #9835

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
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

init query rename and delegation #9835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
46d274c
init query rename and delegation
DogPawHat Nov 1, 2025
16bed21
update spelling
DogPawHat Nov 1, 2025
6d630b0
add respect for select
DogPawHat Nov 2, 2025
7670b40
react query options testing
DogPawHat Nov 2, 2025
a38e428
ci: apply automated fixes
autofix-ci[bot] Nov 2, 2025
fab794f
update changeset
DogPawHat Nov 2, 2025
6aa757c
Merge branch 'implement-simplified-imperitive-methods' of github.com:…
DogPawHat Nov 2, 2025
fb9dcdc
fixes
DogPawHat Nov 2, 2025
3b33d44
more type fixes
DogPawHat Nov 2, 2025
a24433b
fix typo
DogPawHat Nov 2, 2025
4825a0d
typo again
DogPawHat Nov 3, 2025
fa6f86f
Type fix
DogPawHat Nov 3, 2025
c220826
Merge branch 'main' into implement-simplified-imperitive-methods
DogPawHat Nov 5, 2025
560f086
revert delegations
DogPawHat Nov 5, 2025
6a3c2ed
typo
DogPawHat Nov 5, 2025
1338e8e
client update async
DogPawHat Nov 5, 2025
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
7 changes: 7 additions & 0 deletions .changeset/famous-owls-battle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@tanstack/react-query': minor
'@tanstack/query-core': minor
'@tanstack/vue-query': minor
---

renamed imperative methods
137 changes: 132 additions & 5 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 @@ -10,6 +10,7 @@ import type {
EnsureQueryDataOptions,
FetchInfiniteQueryOptions,
InfiniteData,
InfiniteQueryExecuteOptions,
MutationOptions,
OmitKeyof,
QueryKey,
Expand Down Expand Up @@ -157,24 +158,55 @@ describe('getQueryState', () => {
})
})

describe('fetchQuery', () => {
it('should not allow passing select option', () => {
assertType<Parameters<QueryClient['fetchQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
// @ts-expect-error `select` is not supported on fetchQuery options
select: (data: string) => data.length,
},
])
})
})

describe('fetchInfiniteQuery', () => {
it('should not allow passing select option', () => {
assertType<Parameters<QueryClient['fetchInfiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 2,
// @ts-expect-error `select` is not supported on fetchInfiniteQuery options
select: (data) => ({
pages: data.pages.map(
(x: unknown) => `count: ${(x as { count: number }).count}`,
),
pageParams: data.pageParams,
}),
},
])
})

it('should allow passing pages', async () => {
const data = await new QueryClient().fetchInfiniteQuery({
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
queryFn: () => Promise.resolve({ count: 1 }),
getNextPageParam: () => 1,
initialPageParam: 1,
pages: 5,
})

expectTypeOf(data).toEqualTypeOf<InfiniteData<string, number>>()
expectTypeOf(data).toEqualTypeOf<InfiniteData<{ count: number }, number>>()
})

it('should not allow passing getNextPageParam without pages', () => {
assertType<Parameters<QueryClient['fetchInfiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 1,
},
Expand All @@ -183,6 +215,72 @@ describe('fetchInfiniteQuery', () => {

it('should not allow passing pages without getNextPageParam', () => {
assertType<Parameters<QueryClient['fetchInfiniteQuery']>>([
// @ts-expect-error Property 'getNextPageParam' is missing
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
pages: 5,
},
])
})
})

describe('query', () => {
it('should allow passing select option', () => {
assertType<Parameters<QueryClient['query']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve('string'),
select: (data) => (data as string).length,
},
])
})
})

describe('infiniteQuery', () => {
it('should allow passing select option', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 2,
select: (data) => ({
pages: data.pages.map(
(x) => `count: ${(x as { count: number }).count}`,
),
pageParams: data.pageParams,
}),
},
])
})

it('should allow passing pages', async () => {
const data = await new QueryClient().infiniteQuery({
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
getNextPageParam: () => 1,
initialPageParam: 1,
pages: 5,
})

expectTypeOf(data).toEqualTypeOf<InfiniteData<{ count: number }, number>>()
})

it('should not allow passing getNextPageParam without pages', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 1,
},
])
})
Comment on lines +271 to +280
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix misleading test title.

The test uses assertType without @ts-expect-error, meaning it's verifying that passing getNextPageParam without pages is allowed. The title incorrectly says "should not allow".

Apply this diff:

-  it('should not allow passing getNextPageParam without pages', () => {
+  it('should allow passing getNextPageParam without pages', () => {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
it('should not allow passing getNextPageParam without pages', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 1,
},
])
})
it('should allow passing getNextPageParam without pages', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 1,
},
])
})
🤖 Prompt for AI Agents 
In packages/query-core/src/__tests__/queryClient.test-d.tsx around lines 271 to
280, the test title is misleading — it claims "should not allow passing
getNextPageParam without pages" while the body uses assertType (no
@ts-expect-error) which verifies the opposite. Rename the test title to
accurately describe the behavior (for example "should allow passing
getNextPageParam without pages") so the description matches the assertion.


it('should not allow passing pages without getNextPageParam', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
// @ts-expect-error Property 'getNextPageParam' is missing
{
queryKey: ['key'],
Expand Down Expand Up @@ -227,6 +325,16 @@ describe('fully typed usage', () => {
// Construct typed arguments
//

const infiniteQueryOptions: InfiniteQueryExecuteOptions<TData, TError> = {
queryKey: ['key'] as any,
pages: 5,
getNextPageParam: (lastPage) => {
expectTypeOf(lastPage).toEqualTypeOf<TData>()
return 0
},
initialPageParam: 0,
}

const queryOptions: EnsureQueryDataOptions<TData, TError> = {
queryKey: ['key'] as any,
}
Expand All @@ -240,6 +348,7 @@ describe('fully typed usage', () => {
},
initialPageParam: 0,
}

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

const queryFilters: QueryFilters<DataTag<QueryKey, TData, TError>> = {
Expand Down Expand Up @@ -310,11 +419,19 @@ describe('fully typed usage', () => {
const fetchedQuery = await queryClient.fetchQuery(queryOptions)
expectTypeOf(fetchedQuery).toEqualTypeOf<TData>()

const queriedData = await queryClient.query(queryOptions)
expectTypeOf(queriedData).toEqualTypeOf<TData>()

queryClient.prefetchQuery(queryOptions)

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

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

const infiniteQueryData = await queryClient.ensureInfiniteQueryData(
Expand Down Expand Up @@ -449,9 +566,19 @@ describe('fully typed usage', () => {
const fetchedQuery = await queryClient.fetchQuery(queryOptions)
expectTypeOf(fetchedQuery).toEqualTypeOf<unknown>()

const queriedData = await queryClient.query(queryOptions)
expectTypeOf(queriedData).toEqualTypeOf<unknown>()

queryClient.prefetchQuery(queryOptions)

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

const infiniteQuery = await queryClient.infiniteQuery(
fetchInfiniteQueryOptions,
)
expectTypeOf(infiniteQuery).toEqualTypeOf<InfiniteData<unknown, unknown>>()
Expand Down
Loading
Loading