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

ResultOptions.md

23 lines928 Bytes

1---
2id: ResultOptions
3title: ResultOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/query-core/src/types.ts:866](https://github.com/TanStack/query/blob/main/packages/query-core/src/types.ts#L866)
9​
10Options shared by the `QueryClient` and observer methods that refetch queries, controlling
11whether a failed refetch makes the returned promise reject.
12​
13## Extended by
14​
15- [`RefetchOptions`](RefetchOptions.md)
16- [`FetchNextPageOptions`](FetchNextPageOptions.md)
17- [`FetchPreviousPageOptions`](FetchPreviousPageOptions.md)
18​
19## Properties
20​
21| Property | Type | Default value | Description |
22| ------ | ------ | ------ | ------ |
23| <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. |