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
24 changes: 24 additions & 0 deletions packages/react-query/src/__tests__/useQuery.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import type { OmitKeyof, QueryFunction, UseQueryOptions } from '..'

describe('useQuery', () => {
const key = queryKey()
type Post = { title: string }

// unspecified query function should default to unknown
const noQueryFn = useQuery({ queryKey: key })
Expand Down Expand Up @@ -56,6 +57,29 @@ describe('useQuery', () => {
// @ts-expect-error
useQuery<number>({ queryKey: key, queryFn: () => 'test' })

// should error when specifying TData that does not match queryFn data and no select transform is used
// @ts-expect-error
useQuery<Post[], Error, number, string[]>({
queryKey: ['posts'],
queryFn: () =>
Promise.resolve([
{
title: 'Post',
} as Post,
]),
})

useQuery<Post[], Error, number, string[]>({
queryKey: ['posts'],
queryFn: () =>
Promise.resolve([
{
title: 'Post',
} as Post,
]),
select: (posts) => posts.length,
})

// it should infer the result type from a generic query function
function queryFn<T = string>(): Promise<T> {
return Promise.resolve({} as T)
Expand Down
41 changes: 36 additions & 5 deletions packages/react-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,54 @@ import type {
UndefinedInitialDataOptions,
} from './queryOptions'

export function useQuery<
type UseQueryOptionsWithSelect<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
select: Exclude<
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>['select'],
undefined
>
}

type UseQueryOptionsWithoutSelect<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'select'>

export function useQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData extends TQueryFnData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> &
UseQueryOptionsWithoutSelect<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): DefinedUseQueryResult<NoInfer<TData>, TError>

export function useQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TData extends TQueryFnData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> &
UseQueryOptionsWithoutSelect<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>

export function useQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData extends TQueryFnData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
options: UseQueryOptionsWithoutSelect<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>

Expand All @@ -38,7 +69,7 @@ export function useQuery<
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
options: UseQueryOptionsWithSelect<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>

Expand Down