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

errorBoundaryUtils.ts

76 lines1.7 KB

1'use client'
2import * as React from 'react'
3import { shouldThrowError } from './utils'
4import type {
5 DefaultedQueryObserverOptions,
6 Query,
7 QueryKey,
8 QueryObserverResult,
9 ThrowOnError,
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 (
30 options.suspense ||
31 options.throwOnError ||
32 options.experimental_prefetchInRender
33 ) {
34 // Prevent retrying failed query if the error boundary has not been reset yet
35 if (!errorResetBoundary.isReset()) {
36 options.retryOnMount = false
37 }
38 }
40​
41export const useClearResetErrorBoundary = (
42 errorResetBoundary: QueryErrorResetBoundaryValue,
43) => {
44 React.useEffect(() => {
45 errorResetBoundary.clearReset()
46 }, [errorResetBoundary])
48​
49export const getHasError = <
50 TData,
51 TError,
52 TQueryFnData,
53 TQueryData,
54 TQueryKey extends QueryKey,
55>({
56 result,
57 errorResetBoundary,
58 throwOnError,
59 query,
60 suspense,
61}: {
62 result: QueryObserverResult<TData, TError>
63 errorResetBoundary: QueryErrorResetBoundaryValue
64 throwOnError: ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey>
65 query: Query<TQueryFnData, TError, TQueryData, TQueryKey> | undefined
66 suspense: boolean | undefined
67}) => {
68 return (
69 result.isError &&
70 !errorResetBoundary.isReset() &&
71 !result.isFetching &&
72 query &&
73 ((suspense && result.data === undefined) ||
74 shouldThrowError(throwOnError, [result.error, query]))
75 )