Skip to content

Fix: useInfiniteQuery type #2459

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −5
Open

Fix: useInfiniteQuery type #2459

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d919262
fix: :bug: openapi-react-query type definition fix
minchodang Jul 16, 2025
cd3e971
fix: :bug: useInfiniteQuery type safe fix
minchodang Jul 17, 2025
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
18 changes: 13 additions & 5 deletions packages/openapi-react-query/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export type UseQueryMethod<Paths extends Record<string, Record<HttpMethod, {}>>,
: [InitWithUnknowns<Init>, Options?, QueryClient?]
) => UseQueryResult<InferSelectReturnType<Response["data"], Options["select"]>, Response["error"]>;

// Helper type to infer TPageParam type
type InferPageParamType<T> = T extends { initialPageParam: infer P } ? P : unknown;

export type UseInfiniteQueryMethod<Paths extends Record<string, Record<HttpMethod, {}>>, Media extends MediaType> = <
Method extends HttpMethod,
Path extends PathsWithMethod<Paths, Method>,
Expand All @@ -111,13 +114,13 @@ export type UseInfiniteQueryMethod<Paths extends Record<string, Record<HttpMetho
Response["data"],
Response["error"],
InferSelectReturnType<InfiniteData<Response["data"]>, Options["select"]>,
Response["data"],
QueryKey<Paths, Method, Path>,
unknown
InferPageParamType<Options>
>,
"queryKey" | "queryFn"
> & {
pageParamName?: string;
initialPageParam: InferPageParamType<Options>;
},
>(
method: Method,
Expand Down Expand Up @@ -194,7 +197,10 @@ export default function createClient<Paths extends {}, Media extends MediaType =
}: QueryFunctionContext<QueryKey<Paths, Method, Path>>) => {
const mth = method.toUpperCase() as Uppercase<typeof method>;
const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;
const { data, error, response } = await fn(path, { signal, ...(init as any) }); // TODO: find a way to avoid as any
const { data, error, response } = await fn(path, {
signal,
...(init as any),
}); // TODO: find a way to avoid as any
if (error) {
throw error;
}
Expand Down Expand Up @@ -222,12 +228,14 @@ export default function createClient<Paths extends {}, Media extends MediaType =
useSuspenseQuery: (method, path, ...[init, options, queryClient]) =>
useSuspenseQuery(queryOptions(method, path, init as InitWithUnknowns<typeof init>, options), queryClient),
useInfiniteQuery: (method, path, init, options, queryClient) => {
const { pageParamName = "cursor", ...restOptions } = options;
const { pageParamName = "cursor", initialPageParam, ...restOptions } = options;
const { queryKey } = queryOptions(method, path, init);

return useInfiniteQuery(
{
queryKey,
queryFn: async ({ queryKey: [method, path, init], pageParam = 0, signal }) => {
initialPageParam,
queryFn: async ({ queryKey: [method, path, init], pageParam, signal }) => {
const mth = method.toUpperCase() as Uppercase<typeof method>;
const fn = client[mth] as ClientMethod<Paths, typeof method, Media>;
const mergedInit = {
Expand Down
Loading