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

UseQueryOptions.md

49 lines974 Bytes

1---
2id: UseQueryOptions
3title: UseQueryOptions
4---
5​
6# Interface: UseQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>
7​
8Defined in: [preact-query/src/types.ts:65](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L65)
9​
10## Extends
11​
12- `OmitKeyof`\<[`UseBaseQueryOptions`](UseBaseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\>
13​
14## Type Parameters
15​
16### TQueryFnData
17​
18`TQueryFnData` = `unknown`
19​
20### TError
21​
22`TError` = `DefaultError`
23​
24### TData
25​
26`TData` = `TQueryFnData`
27​
28### TQueryKey
29​
30`TQueryKey` *extends* `QueryKey` = `QueryKey`
31​
32## Properties
33​
34### subscribed?
35​
36```ts
37optional subscribed: boolean;
38```
39​
40Defined in: [preact-query/src/types.ts:46](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L46)
41​
42Set this to `false` to unsubscribe this observer from updates to the query cache.
43Defaults to `true`.
44​
45#### Inherited from
46​
47```ts
48OmitKeyof.subscribed
49```