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

ResetOptions.md

22 lines1015 Bytes

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