0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/react/reference/functions/QueryErrorResetBoundary.md
Wonsuk Choi ba341f5a07
docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools (#11843)
* docs(react-query): add missing JSDoc to react-query, react-query-next-experimental, and react-query-devtools

* docs(react-query-next-experimental): correct where streamed hydration and HTML insertion happen
2026-10-04 04:15:50 +09:00

1.5 KiB

id title redirect_from
QueryErrorResetBoundary QueryErrorResetBoundary
framework/react/reference/QueryErrorResetBoundary
function QueryErrorResetBoundary(props: QueryErrorResetBoundaryProps): Element;

Defined in: packages/react-query/src/QueryErrorResetBoundary.tsx:135

When using suspense or throwOnError in your queries, you need a way to let queries know that you want to try again when re-rendering after some error occurred. With the QueryErrorResetBoundary component you can reset any query errors within the boundaries of the component.

Parameters

props

QueryErrorResetBoundaryProps

The children to render.

Returns

Element

The children, rendered as-is, or called with the boundary's QueryErrorResetBoundaryValue if children is a function.

Example

import { ErrorBoundary } from 'react-error-boundary'
import { QueryErrorResetBoundary } from '@tanstack/react-query'

function App() {
  return (
    <QueryErrorResetBoundary>
      {({ reset }) => (
        <ErrorBoundary
          onReset={reset}
          fallbackRender={({ resetErrorBoundary }) => (
            <div>
              There was an error!
              <button onClick={() => resetErrorBoundary()}>Try again</button>
            </div>
          )}
        >
          <Page />
        </ErrorBoundary>
      )}
    </QueryErrorResetBoundary>
  )
}