Repository navigation
Generates incorrect queryKeys for Infinite queries #140
Description
Activity
- changed the title
[-]generates incorrect queryKeys for Infinite queries[/-][+]Generates incorrect queryKeys for Infinite queries[/+]on Aug 19, 2024 - added a commit that references this issue
on Jul 10, 2026 - added a commit that references this issue
on Jul 18, 2026 Fixed in v3.0.0.
Infinite queries now get their own key constant and key function, separate from the plain query ones, and the page parameter is excluded from the infinite key at the type level:
export type FindPaginatedPetsInfiniteClientOptions = Omit<Options<FindPaginatedPetsData, true>, "query"> & { query?: Omit<NonNullable<FindPaginatedPetsData["query"]>, "page"> }; export const useFindPaginatedPetsInfiniteKey = [useFindPaginatedPetsKey, "infinite"] as const; export const UseFindPaginatedPetsInfiniteKeyFn = (clientOptions: FindPaginatedPetsInfiniteClientOptions = {}, queryKey?: Array<unknown>) => [...useFindPaginatedPetsInfiniteKey, ...(queryKey ?? [clientOptions])];
The page value is threaded into the request only (
query: { ...clientOptions.query, page: pageParam }), never into the key — so the key stays stable across pages, which is the behaviour TanStack Query expects.Note the infinite key nests the plain key as its first segment. That means
invalidateQueries({ queryKey: [useFindPaginatedPetsKey] })still matches both caches, while the"infinite"segment keeps cachedInfiniteDatafrom colliding with plain query data.A custom page-param name (
--pageParam) is respected in theOmit. Available onlatest(npm i @7nohe/openapi-react-query-codegen@3). Thanks for the clear report — the two-key-set design is exactly what you proposed.
Describe the bug
Generates incorrect queryKeys for Infinite queries, the page is expected to be sent into the
KeyFn.To Reproduce
Steps to reproduce the behavior:
openapi-rq --pageParam page --input https://localhost:44353/swagger/v1/swagger.json --output src/openapi/.Expected behavior
I think you need 2 sets for
KeyFnfunctions one for Infinite queries and one for the normal request.Where the
Infiniteversion excludes the page.Screenshots
