Skip to content

docs(useInfiniteQuery): add warning about fetchNextPage disrupting default refetch behaviour #6024

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

Merged
merged 1 commit into from
Sep 17, 2023
Merged

docs(useInfiniteQuery): add warning about fetchNextPage disrupting default refetch behaviour #6024

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
4 changes: 3 additions & 1 deletion docs/react/reference/useInfiniteQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,6 @@ The returned properties for `useInfiniteQuery` are identical to the [`useQuery`
- This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).
- `isRefetching: boolean`
- Is `true` whenever a background refetch is in-flight, which _does not_ include initial `loading` or fetching of next or previous page
- Is the same as `isFetching && !isLoading && !isFetchingNextPage && !isFetchingPreviousPage`
- Is the same as `isFetching && !isLoading && !isFetchingNextPage && !isFetchingPreviousPage`

Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default refetch behaviour, resulting in outdated data. Make sure to call these functions only in response to user actions, or add conditions like `hasNextPage && !isFetching`.