feat: expose errorUpdateCount on useQuery (TanStack#3532)

* expose errorUpdateCount on useQuery

* refactored test slightly

* Update docs/src/pages/reference/useQuery.md

as  suggested

Co-authored-by: Dominik Dorfmeister <[email protected]>

* removed the first click as we fetch on default,

* prettier

* added errorUpdateCount to failed tests.

* prettier

Co-authored-by: Dominik Dorfmeister <[email protected]>

Author: OmerCohenAviv

docs/src/pages/reference/useQuery.md

@@ -238,6 +238,8 @@ const result = useQuery({
   - The failure count for the query.
   - Incremented every time the query fails.
   - Reset to `0` when the query succeeds.
+- `errorUpdateCount: number`
+  - The sum of all errors.
 - `refetch: (options: { throwOnError: boolean, cancelRefetch: boolean }) => Promise<UseQueryResult>`
   - A function to manually refetch the query.
   - If the query errors, the error will only be logged. If you want an error to be thrown, pass the `throwOnError: true` option

src/core/queryObserver.ts

@@ -594,6 +594,7 @@ export class QueryObserver<
       error,
       errorUpdatedAt,
       failureCount: state.fetchFailureCount,
+      errorUpdateCount: state.errorUpdateCount,
       isFetched: state.dataUpdateCount > 0 || state.errorUpdateCount > 0,
       isFetchedAfterMount:
         state.dataUpdateCount > queryInitialState.dataUpdateCount ||

src/core/types.ts

@@ -328,6 +328,7 @@ export interface QueryObserverBaseResult<TData = unknown, TError = unknown> {
   error: TError | null
   errorUpdatedAt: number
   failureCount: number
+  errorUpdateCount: number
   isError: boolean
   isFetched: boolean
   isFetchedAfterMount: boolean

src/react/tests/useInfiniteQuery.test.tsx

@@ -73,6 +73,7 @@ describe('useInfiniteQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 0,
+      errorUpdateCount: 0,
       fetchNextPage: expect.any(Function),
       fetchPreviousPage: expect.any(Function),
       hasNextPage: undefined,
@@ -103,6 +104,7 @@ describe('useInfiniteQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 0,
+      errorUpdateCount: 0,
       fetchNextPage: expect.any(Function),
       fetchPreviousPage: expect.any(Function),
       hasNextPage: true,

src/react/tests/useQuery.test.tsx

@@ -169,6 +169,7 @@ describe('useQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 0,
+      errorUpdateCount: 0,
       isError: false,
       isFetched: false,
       isFetchedAfterMount: false,
@@ -193,6 +194,7 @@ describe('useQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 0,
+      errorUpdateCount: 0,
       isError: false,
       isFetched: true,
       isFetchedAfterMount: true,
@@ -247,6 +249,7 @@ describe('useQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 0,
+      errorUpdateCount: 0,
       isError: false,
       isFetched: false,
       isFetchedAfterMount: false,
@@ -271,6 +274,7 @@ describe('useQuery', () => {
       error: null,
       errorUpdatedAt: 0,
       failureCount: 1,
+      errorUpdateCount: 0,
       isError: false,
       isFetched: false,
       isFetchedAfterMount: false,
@@ -295,6 +299,7 @@ describe('useQuery', () => {
       error: 'rejected',
       errorUpdatedAt: expect.any(Number),
       failureCount: 2,
+      errorUpdateCount: 1,
       isError: true,
       isFetched: true,
       isFetchedAfterMount: true,