Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .changeset/dull-masks-melt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@tanstack/preact-query': patch
'@tanstack/react-query': patch
---

revert: remove NoInfer from useQuery return types
34 changes: 17 additions & 17 deletions packages/preact-query/src/__tests__/useQuery.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -278,23 +278,6 @@ describe('useQuery', () => {
}
})

// eslint-disable-next-line vitest/expect-expect
it('TData should depend from only arguments, not the result', () => {
// @ts-expect-error
// eslint-disable-next-line
const result: UseQueryResult<{ wow: string }> = useQuery({
queryKey: queryKey(),
queryFn: () => {
return {
wow: true,
}
},
initialData: () => undefined as { wow: boolean } | undefined,
})

void result
})

it('data should not have undefined when initialData is provided', () => {
const { data } = useQuery({
queryKey: queryKey(),
Expand All @@ -305,6 +288,23 @@ describe('useQuery', () => {
})
})

it('should preserve discriminated-union narrowing', () => {
type Result =
| { type: 'first'; first: string }
| { type: 'second'; second: string }

const query = useQuery({
queryKey: queryKey(),
queryFn: (): Result => ({ type: 'first', first: 'a' }),
})

const second = query.data?.type === 'first' ? undefined : query.data

expectTypeOf(second).toEqualTypeOf<
{ type: 'second'; second: string } | undefined
>()
})

describe('custom hook', () => {
it('should allow custom hooks using UseQueryOptions', () => {
type Data = string
Expand Down
6 changes: 3 additions & 3 deletions packages/preact-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export function useQuery<
>(
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): DefinedUseQueryResult<NoInfer<TData>, TError>
): DefinedUseQueryResult<TData, TError>

export function useQuery<
TQueryFnData = unknown,
Expand All @@ -30,7 +30,7 @@ export function useQuery<
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>
): UseQueryResult<TData, TError>

export function useQuery<
TQueryFnData = unknown,
Expand All @@ -40,7 +40,7 @@ export function useQuery<
>(
options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>
): UseQueryResult<TData, TError>

export function useQuery(options: UseQueryOptions, queryClient?: QueryClient) {
return useBaseQuery(options, QueryObserver, queryClient)
Expand Down
23 changes: 12 additions & 11 deletions packages/react-query/src/__tests__/useQuery.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -277,20 +277,21 @@ describe('useQuery', () => {
}
})

// eslint-disable-next-line vitest/expect-expect
it('TData should depend from only arguments, not the result', () => {
// @ts-expect-error
const result: UseQueryResult<{ wow: string }> = useQuery({
it('should preserve discriminated-union narrowing', () => {
type Result =
| { type: 'first'; first: string }
| { type: 'second'; second: string }

const query = useQuery({
queryKey: queryKey(),
queryFn: () => {
return {
wow: true,
}
},
initialData: () => undefined as { wow: boolean } | undefined,
queryFn: (): Result => ({ type: 'first', first: 'a' }),
})

void result
const second = query.data?.type === 'first' ? undefined : query.data

expectTypeOf(second).toEqualTypeOf<
{ type: 'second'; second: string } | undefined
>()
})

it('data should not have undefined when initialData is provided', () => {
Expand Down
6 changes: 3 additions & 3 deletions packages/react-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export function useQuery<
>(
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): DefinedUseQueryResult<NoInfer<TData>, TError>
): DefinedUseQueryResult<TData, TError>

export function useQuery<
TQueryFnData = unknown,
Expand All @@ -30,7 +30,7 @@ export function useQuery<
>(
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>
): UseQueryResult<TData, TError>

export function useQuery<
TQueryFnData = unknown,
Expand All @@ -40,7 +40,7 @@ export function useQuery<
>(
options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
queryClient?: QueryClient,
): UseQueryResult<NoInfer<TData>, TError>
): UseQueryResult<TData, TError>

export function useQuery(options: UseQueryOptions, queryClient?: QueryClient) {
return useBaseQuery(options, QueryObserver, queryClient)
Expand Down
Loading