Skip to content
Open
Show file tree
Hide file tree
Changes from 16 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
7 changes: 7 additions & 0 deletions .changeset/famous-owls-battle.md
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
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,
Copy link
Collaborator

Choose a reason for hiding this comment

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

shouldn’t string be inferred here?

Suggested change
select: (data) => (data as string).length,
select: (data) => data.length,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It inferrs as unknown in this case, because I think the generic in assertTypeOf has already intialised TQueryFnData to unknown

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ended up making a stub queryOptions fn to make the inference work with select. but the assertType still fails comparing string to unknown.

},
])
})
})

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}`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

this assertion also shouldn’t be necessary if types flow correctly

),
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 allow passing getNextPageParam without pages', () => {
assertType<Parameters<QueryClient['infiniteQuery']>>([
{
queryKey: ['key'],
queryFn: () => Promise.resolve({ count: 1 }),
initialPageParam: 1,
getNextPageParam: () => 1,
},
])
})

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> = {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you need 4 type params to avoid the type assertion on the query key

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