Skip to content

fix(vue-query): fix type inference #6210

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

Merged
merged 1 commit into from
Oct 20, 2023
Merged

fix(vue-query): fix type inference #6210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions packages/vue-query/src/useBaseQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import type {
QueryObserverResult,
} from '@tanstack/query-core'
import type { QueryClient } from './queryClient'
import type { UseQueryOptions, UseQueryReturnType } from './useQuery'
import type { UseQueryOptions } from './useQuery'
import type { UseInfiniteQueryOptions } from './useInfiniteQuery'

export type UseBaseQueryReturnType<
Expand Down Expand Up @@ -202,5 +202,5 @@ export function useBaseQuery<
object.suspense = suspense
object.refetch = refetch

return object as UseQueryReturnType<TData, TError>
return object as UseBaseQueryReturnType<TData, TError>
}
4 changes: 1 addition & 3 deletions packages/vue-query/src/useInfiniteQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export type UseInfiniteQueryOptions<
TQueryData,
TQueryKey,
TPageParam
>]: Property extends 'queryFn'
>]: Property extends 'queryFn' | 'getPreviousPageParam' | 'getNextPageParam'
? InfiniteQueryObserverOptions<
TQueryFnData,
TError,
Expand Down Expand Up @@ -103,9 +103,7 @@ export function useInfiniteQuery<
>,
queryClient?: QueryClient,
): UseInfiniteQueryReturnType<TData, TError> {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
const result = useBaseQuery(
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
InfiniteQueryObserver as typeof QueryObserver,
options,
queryClient,
Expand Down
48 changes: 35 additions & 13 deletions packages/vue-query/src/useQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import type {
} from './types'
import type { QueryClient } from './queryClient'

type NonUndefinedGuard<T> = T extends undefined ? never : T

export type UseQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
Expand Down Expand Up @@ -64,6 +66,26 @@ export type UseQueryOptions<
>
}>

export type UndefinedInitialQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
initialData?: undefined
}

export type DefinedInitialQueryOptions<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> & {
initialData:
| NonUndefinedGuard<TQueryFnData>
| (() => NonUndefinedGuard<TQueryFnData>)
}

export type UseQueryReturnType<TData, TError> = DistributiveOmit<
UseBaseQueryReturnType<TData, TError>,
'refetch'
Expand All @@ -85,18 +107,20 @@ export function useQuery<
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: UseQueryOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
TQueryKey
> & {
initialData?: undefined
},
options: UndefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryReturnType<TData, TError>

export function useQuery<
TQueryFnData = unknown,
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
>(
options: DefinedInitialQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryDefinedReturnType<TData, TError>

export function useQuery<
TQueryFnData = unknown,
TError = DefaultError,
Expand All @@ -109,11 +133,9 @@ export function useQuery<
TData,
TQueryFnData,
TQueryKey
> & {
initialData: TQueryFnData | (() => TQueryFnData)
},
>,
queryClient?: QueryClient,
): UseQueryDefinedReturnType<TData, TError>
): UseQueryReturnType<TData, TError>

export function useQuery<
TQueryFnData,
Expand Down