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

RefetchOptions.md

24 lines1.0 KB

1---
2id: RefetchOptions
3title: RefetchOptions
4---
5​
6Defined in: [packages/query-core/src/types.ts:878](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L878)
7​
8Options of the methods that refetch queries, like `refetch` and `queryClient.refetchQueries`.
9​
10## Extends
11​
12- [`ResultOptions`](ResultOptions.md)
13​
14## Extended by
15​
16- [`InvalidateOptions`](InvalidateOptions.md)
17- [`ResetOptions`](ResetOptions.md)
18​
19## Properties
20​
21| Property | Type | Default value | Description |
22| ------ | ------ | ------ | ------ |
23| <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. |
24| <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. |