Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

InvalidateOptions.md

21 lines1022 Bytes

1---
2id: InvalidateOptions
3title: InvalidateOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/query-core/src/types.ts:918](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L918)
9​
10Options of `queryClient.invalidateQueries`, applied to the refetch that follows the invalidation.
11​
12## Extends
13​
14- [`RefetchOptions`](RefetchOptions.md)
15​
16## Properties
17​
18| Property | Type | Default value | Description |
19| ------ | ------ | ------ | ------ |
20| <a id="property-cancelrefetch"></a> `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. |
21| <a id="property-throwonerror"></a> `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. |