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 KiB
1 KiB
| id | title |
|---|---|
| shouldThrowError | shouldThrowError |
function shouldThrowError<T>(throwOnError, params): boolean;
Defined in: packages/query-core/src/utils.ts:576
Resolves a throwOnError option to a boolean.
If throwOnError is a function, it is called with params (e.g. the error and, depending on the caller,
additional context such as the query or mutation) and its result is returned, allowing the throwing
behavior to be decided per error. Otherwise, throwOnError itself is coerced to a boolean (undefined
resolves to false).
Type Parameters
T
T extends (...args) => boolean
Parameters
throwOnError
boolean | T | undefined
params
Parameters<T>
Returns
boolean
Example
const throwOnError =
query.state.error && typeof options.throwOnError === 'function'
? shouldThrowError(options.throwOnError, [query.state.error, query])
: options.throwOnError