Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
5 changes: 5 additions & 0 deletions .changeset/cute-cloths-switch.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@tanstack/preact-query': minor
---

update usePrefetchQuery to use new methods
12 changes: 12 additions & 0 deletions packages/preact-query/src/__tests__/useInfiniteQuery.test-d.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,18 @@ describe('pageParam', () => {
})
})

it('initialPageParam should define type of param passed to queryFunctionContext for infiniteQuery', () => {
const queryClient = new QueryClient()
queryClient.infiniteQuery({
queryKey: ['key'],
queryFn: ({ pageParam }) => {
expectTypeOf(pageParam).toEqualTypeOf<number>()
return Promise.resolve(pageParam)
},
initialPageParam: 1,
})
})

it('initialPageParam should define type of param passed to queryFunctionContext for prefetchInfiniteQuery', () => {
const queryClient = new QueryClient()
queryClient.prefetchInfiniteQuery({
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,18 +42,16 @@ describe('usePrefetchQuery', () => {
)
})

it('should not allow skipToken in queryFn', () => {
it('should allow skipToken in queryFn', () => {
assertType(
usePrefetchQuery({
queryKey: queryKey(),
// @ts-expect-error
queryFn: skipToken,
}),
)
assertType(
usePrefetchQuery({
queryKey: queryKey(),
// @ts-expect-error
queryFn: Math.random() > 0.5 ? skipToken : () => Promise.resolve(5),
}),
)
Expand Down
16 changes: 0 additions & 16 deletions packages/preact-query/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import type {
DefinedInfiniteQueryObserverResult,
DefinedQueryObserverResult,
DistributiveOmit,
FetchQueryOptions,
InfiniteQueryObserverOptions,
InfiniteQueryObserverResult,
MutateFunction,
Expand DownExpand Up@@ -45,21 +44,6 @@ export interface UseBaseQueryOptions<
subscribed?: boolean
}

export interface UsePrefetchQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> extends OmitKeyof<
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
'queryFn'
> {
queryFn?: Exclude<
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
SkipToken
>
}

export type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>
export interface UseQueryOptions<
TQueryFnData = unknown,
Expand Down
7 changes: 4 additions & 3 deletions packages/preact-query/src/usePrefetchInfiniteQuery.tsx
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { noop } from '@tanstack/query-core'
import type {
DefaultError,
FetchInfiniteQueryOptions,
QueryClient,
QueryKey,
InfiniteQueryExecuteOptions,
} from '@tanstack/query-core'

import { useQueryClient } from './QueryClientProvider'
Expand All@@ -14,7 +15,7 @@ export function usePrefetchInfiniteQuery<
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
>(
options: FetchInfiniteQueryOptions<
options: InfiniteQueryExecuteOptions<
TQueryFnData,
TError,
TData,
Expand All@@ -26,6 +27,6 @@ export function usePrefetchInfiniteQuery<
const client = useQueryClient(queryClient)

if (!client.getQueryState(options.queryKey)) {
client.prefetchInfiniteQuery(options)
void client.infiniteQuery(options).then(noop).catch(noop)
}
}
13 changes: 9 additions & 4 deletions packages/preact-query/src/usePrefetchQuery.tsx
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
import type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'
import { noop } from '@tanstack/query-core'
import type {
DefaultError,
QueryClient,
QueryKey,
QueryExecuteOptions,
} from '@tanstack/query-core'

import { useQueryClient } from './QueryClientProvider'
import type { UsePrefetchQueryOptions } from './types'

export function usePrefetchQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UsePrefetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
options: QueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
) {
const client = useQueryClient(queryClient)

if (!client.getQueryState(options.queryKey)) {
client.prefetchQuery(options)
void client.fetchQuery(options).then(noop).catch(noop)
}
}