Skip to content

docs(reference/QueryCache): clarify fetchFailureCount availability in onError callback #10724

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
seongwon030 wants to merge 3 commits into
base: main
Choose a base branch
from
+8 −2
Open

docs(reference/QueryCache): clarify fetchFailureCount availability in onError callback #10724

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5ef57f
docs(reference/QueryCache): clarify fetchFailureCount availability in…
seongwon030 May 18, 2026
386afab
docs(reference/QueryCache): improve fetchFailureCount comment clarity
seongwon030 May 20, 2026
ff5805b
docs(reference/QueryCache): clarify fetchFailureCount counts failed a…
seongwon030 May 20, 2026
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
10 changes: 8 additions & 2 deletions docs/reference/QueryCache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,13 @@ The `QueryCache` is the storage mechanism for TanStack Query. It stores all the
import { QueryCache } from '@tanstack/react-query'

const queryCache = new QueryCache({
onError: (error) => {
console.log(error)
onError: (error, query) => {
// query.state.fetchFailureCount is the total number of failed attempts including retries
if (query.state.fetchFailureCount > 1) {
console.error(`Failed after retries:`, error)
} else {
console.error(`First attempt failed:`, error)
}
},
onSuccess: (data) => {
console.log(data)
Expand All @@ -38,6 +43,7 @@ Its available methods are:
- `onError?: (error: unknown, query: Query) => void`
- Optional
- This function will be called if some query encounters an error.
- `query.state.fetchFailureCount` indicates how many failed fetch attempts were made (including retries), which can be used to differentiate a first failure from a failure after retries.
- `onSuccess?: (data: unknown, query: Query) => void`
- Optional
- This function will be called if some query is successful.
Expand Down