0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/react/reference/interfaces/InvalidateOptions.md
Wonsuk Choi 9dd4d7d506
docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases (#11891)
* docs(query-core/types): add JSDoc to the properties of the exported interfaces and type aliases

* docs(query-core/types): mention mutations in the 'hydrate' default options description
2026-10-05 01:55:45 +09:00

931 B

id title
InvalidateOptions InvalidateOptions

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

Options of queryClient.invalidateQueries, applied to the refetch that follows the invalidation.

Extends

Properties

Property Type Default value Description
cancelRefetch? boolean true 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.
throwOnError? boolean false If set to true, the method throws if any of the underlying query refetch tasks fail. If set to false, failed refetches are swallowed and not surfaced to the caller.