shouldThrowError

function shouldThrowError<T>(throwOnError: boolean | T | undefined, params: Parameters<T>): boolean;

Defined in: packages/query-core/src/utils.ts:693

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: any[]) => boolean

Parameters

throwOnError

boolean | T | undefined

The throwOnError option: a boolean, a function that decides per error, or undefined.

params

Parameters<T>

The arguments passed to throwOnError if it is a function.

Returns

boolean

Whether the error should be thrown.

Example

const throwOnError =
  query.state.error && typeof options.throwOnError === 'function'
    ? shouldThrowError(options.throwOnError, [query.state.error, query])
    : options.throwOnError