mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.6 KiB
1.6 KiB
| id | title |
|---|---|
| QueryErrorResetBoundary | QueryErrorResetBoundary |
function QueryErrorResetBoundary(__namedParameters): Element;
Defined in: packages/preact-query/src/QueryErrorResetBoundary.tsx:159
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
__namedParameters
Returns
Element
The children, rendered as-is, or called with the boundary's QueryErrorResetBoundaryValue
if children is a function.
Example
import { useErrorBoundary } from 'preact/hooks'
import type { ComponentChildren } from 'preact'
import { QueryErrorResetBoundary } from '@tanstack/preact-query'
function App() {
return (
<QueryErrorResetBoundary>
{({ reset }) => (
<ErrorBoundary reset={reset}>
<Page />
</ErrorBoundary>
)}
</QueryErrorResetBoundary>
)
}
function ErrorBoundary({
children,
reset,
}: {
children: ComponentChildren
reset: () => void
}) {
const [error, resetError] = useErrorBoundary(() => reset())
if (error) {
return (
<div>
There was an error!
<button onClick={() => resetError()}>Try again</button>
</div>
)
}
return children
}