API Reference

InvalidateOptions

Defined in: packages/query-core/src/types.ts:734

Extends

Properties

cancelRefetch?

ts
optional cancelRefetch: boolean;

Defined in: packages/query-core/src/types.ts:712

If set to true, a currently running request will be cancelled before a new request is made

If set to false, no refetch will be made if there is already a request running.

Defaults to true.

Inherited from

RefetchOptions.cancelRefetch


throwOnError?

ts
optional throwOnError: boolean;

Defined in: packages/query-core/src/types.ts:701

If set to true, the method throws if any of the underlying query refetch tasks fail.

Defaults to false, in which case failed refetches are swallowed and not surfaced to the caller.

Inherited from

RefetchOptions.throwOnError