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

UseBaseQueryOptions.md

47 lines936 Bytes

1---
2id: UseBaseQueryOptions
3title: UseBaseQueryOptions
4---
5​
6# Interface: UseBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
7​
8Defined in: [preact-query/src/types.ts:29](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L29)
9​
10## Extends
11​
12- `QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\>
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### TQueryData
29​
30`TQueryData` = `TQueryFnData`
31​
32### TQueryKey
33​
34`TQueryKey` *extends* `QueryKey` = `QueryKey`
35​
36## Properties
37​
38### subscribed?
39​
40```ts
41optional subscribed: boolean;
42```
43​
44Defined in: [preact-query/src/types.ts:46](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L46)
45​
46Set this to `false` to unsubscribe this observer from updates to the query cache.
47Defaults to `true`.