infiniteQuery throws "getNextPageParam is not a function" when 2+ stale pages are cached
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- frontend
Research direction
The failing path is the infiniteQuery and fetchInfiniteQuery handling in query-core when stale pages are already cached, and the error surfaces as options.getNextPageParam is not a function. Start by reproducing with the stackblitz example or a small test that seeds two pages with setQueryData, then trace where getNextPageParam is read during the refetch of existing pages. Done means the call either works without the callback or the types require it, with a regression test covering the stale multi-page case.
Written by the indexing model from the issue text.
Description
Describe the bug
Hey :)
I ran into this while testing query-core.
I can call queryClient.infiniteQuery without getNextPageParam as long as I don't pass pages. TypeScript is fine with it, and it works on an empty cache.
But if the same key already has 2 or more pages cached and they're stale, the exact same call throws:
TypeError: options.getNextPageParam is not a function
Same with fetchInfiniteQuery. prefetchInfiniteQuery doesn't throw, but it leaves the query in an error state.
So the same call works or crashes depending on what's already in the cache.
Thanks!
Your minimal, reproducible example
https://stackblitz.com/github/a-botermans/tanstack-query-infinite-repro
Steps to reproduce
- Have 2 pages in the cache for a key. The demo uses
setQueryData, but loading them withuseInfiniteQuery+fetchNextPagegives the same result. - Let them go stale. The default
staleTime: 0is enough. - Call
infiniteQueryon the same key, withoutpagesand withoutgetNextPageParam:
queryClient.setQueryData(['pages'], {
pages: ['page 0', 'page 1'],
pageParams: [0, 1],
})
await queryClient.infiniteQuery({
queryKey: ['pages'],
queryFn: ({ pageParam }) => `page ${pageParam}`,
initialPageParam: 0,
})
It refetches the first page fine, then throws when it needs the param for page 2.
Expected behavior
No internal TypeError for a call the types accept. Either it works without the callback, or the types should ask for it.
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
Not platform specific. Reproduced on Node 26 and in Chromium.
Tanstack Query adapter
vanilla
TanStack Query version
v5.107.1
TypeScript version
v5.6.3
Additional context
- The same steps work on 4.44.0 and fail on 5.0.0, so it looks like it came in with v5.
- With the default retries in the browser, the TypeError gets retried like a network error. The call hangs for about 7 seconds before it rejects.
- Workaround: pass
getNextPageParamin the call too. Then it refetches all the pages.
- Dominant language
- TypeScript
- Stars
- 50.6k
- Forks
- 4.2k
- Avg merge
- 8h 37m
- Merged PRs (30d)
- 450
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from TanStack/query
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
TanStack/query#12466 · 1 comment ·
Maintainers usually reply within 1 day
-
solid-query: STRICT_READ_UNTRACKED on Solid 2 — client()/options() read in component body (useMutation, useBaseQuery)May be free again @LeonxLJX claimed this 74 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
TanStack/query#11358 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
Infinite render loop when select maps keepPreviousData to undefined in v5.105.2+Possibly taken @mooxl claimed this 6 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
TanStack/query#12574 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
Similar issues
-
Type/Improvement
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
OpenNSW/nsw-srilanka#1259 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oxc-project/tsrs#1010 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Fission-AI/OpenSpec#2260 ·
Maintainers usually reply within 1 day
-
Add: ESP 1 UKOpencheck:passed streams:add
Difficulty 1/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
area:infra area:storage bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
THU-MAIC/OpenMAIC#2311 · 1 comment ·
Maintainers usually reply within 1 day