Skip to content

fix(preact-query): infer infinite pageParam in useInfiniteQuery return type #10841

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

Closed
raashish1601 wants to merge 1 commit into from
+27 −7
Closed

fix(preact-query): infer infinite pageParam in useInfiniteQuery return type #10841

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
6 changes: 2 additions & 4 deletions packages/preact-query/src/__tests__/useInfiniteQuery.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,8 @@ describe('select', () => {
getNextPageParam: () => undefined,
})

// TODO: Order of generics prevents pageParams to be typed correctly. Using `unknown` for now
expectTypeOf(infiniteQuery.data).toEqualTypeOf<
InfiniteData<number, unknown> | undefined
InfiniteData<number, number> | undefined
>()
})

Expand Down Expand Up @@ -113,9 +112,8 @@ describe('getNextPageParam / getPreviousPageParam', () => {
},
})

// TODO: Order of generics prevents pageParams to be typed correctly. Using `unknown` for now
expectTypeOf(infiniteQuery.data).toEqualTypeOf<
InfiniteData<string, unknown> | undefined
InfiniteData<string, number> | undefined
>()
})
})
Expand Down
28 changes: 25 additions & 3 deletions packages/preact-query/src/useInfiniteQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ import type {
} from './types'
import { useBaseQuery } from './useBaseQuery'

type IsUnknown<T> = unknown extends T
? [T] extends [never]
? false
: true
: false

type ResolvePageParamData<TQueryFnData, TData, TPageParam> =
TData extends InfiniteData<TQueryFnData, infer TDataPageParam>
? IsUnknown<TDataPageParam> extends true
? InfiniteData<TQueryFnData, TPageParam>
: TData
: TData

export function useInfiniteQuery<
TQueryFnData,
TError = DefaultError,
Expand All @@ -33,7 +46,10 @@ export function useInfiniteQuery<
TPageParam
>,
queryClient?: QueryClient,
): DefinedUseInfiniteQueryResult<TData, TError>
): DefinedUseInfiniteQueryResult<
ResolvePageParamData<TQueryFnData, TData, TPageParam>,
TError
>

export function useInfiniteQuery<
TQueryFnData,
Expand All @@ -50,7 +66,10 @@ export function useInfiniteQuery<
TPageParam
>,
queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError>
): UseInfiniteQueryResult<
ResolvePageParamData<TQueryFnData, TData, TPageParam>,
TError
>

export function useInfiniteQuery<
TQueryFnData,
Expand All @@ -67,7 +86,10 @@ export function useInfiniteQuery<
TPageParam
>,
queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError>
): UseInfiniteQueryResult<
ResolvePageParamData<TQueryFnData, TData, TPageParam>,
TError
>

export function useInfiniteQuery(
options: UseInfiniteQueryOptions,
Expand Down