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

ResetOptions.md

20 lines942 Bytes

1---
2id: ResetOptions
3title: ResetOptions
4---
5​
6Defined in: [packages/query-core/src/types.ts:922](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L922)
7​
8Options of `queryClient.resetQueries`, applied to the refetch of the active queries after the
9reset.
10​
11## Extends
12​
13- [`RefetchOptions`](RefetchOptions.md)
14​
15## Properties
16​
17| Property | Type | Default value | Description |
18| ------ | ------ | ------ | ------ |
19| <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. |
20| <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. |