Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

errorBoundaryUtils.ts

73 lines1.6 KB

1'use client'
2import * as React from 'react'
3import { shouldThrowError } from './utils'
4import type {
5 DefaultedQueryObserverOptions,
6 Query,
7 QueryKey,
8 QueryObserverResult,
9 UseErrorBoundary,
10} from '@tanstack/query-core'
11import type { QueryErrorResetBoundaryValue } from './QueryErrorResetBoundary'
12​
13export const ensurePreventErrorBoundaryRetry = <
14 TQueryFnData,
15 TError,
16 TData,
17 TQueryData,
18 TQueryKey extends QueryKey,
19>(
20 options: DefaultedQueryObserverOptions<
21 TQueryFnData,
22 TError,
23 TData,
24 TQueryData,
25 TQueryKey
26 >,
27 errorResetBoundary: QueryErrorResetBoundaryValue,
28) => {
29 if (options.suspense || options.useErrorBoundary) {
30 // Prevent retrying failed query if the error boundary has not been reset yet
31 if (!errorResetBoundary.isReset()) {
32 options.retryOnMount = false
33 }
34 }
36​
37export const useClearResetErrorBoundary = (
38 errorResetBoundary: QueryErrorResetBoundaryValue,
39) => {
40 React.useEffect(() => {
41 errorResetBoundary.clearReset()
42 }, [errorResetBoundary])
44​
45export const getHasError = <
46 TData,
47 TError,
48 TQueryFnData,
49 TQueryData,
50 TQueryKey extends QueryKey,
51>({
52 result,
53 errorResetBoundary,
54 useErrorBoundary,
55 query,
56}: {
57 result: QueryObserverResult<TData, TError>
58 errorResetBoundary: QueryErrorResetBoundaryValue
59 useErrorBoundary: UseErrorBoundary<
60 TQueryFnData,
61 TError,
62 TQueryData,
63 TQueryKey
64 >
65 query: Query<TQueryFnData, TError, TQueryData, TQueryKey>
66}) => {
67 return (
68 result.isError &&
69 !errorResetBoundary.isReset() &&
70 !result.isFetching &&
71 shouldThrowError(useErrorBoundary, [result.error, query])
72 )