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

ResultOptions.md

21 lines855 Bytes

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