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

UseSuspenseQueryOptions.md

59 lines1.2 KB

1---
2id: UseSuspenseQueryOptions
3title: UseSuspenseQueryOptions
4---
5​
6# Interface: UseSuspenseQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>
7​
8Defined in: [preact-query/src/types.ts:81](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L81)
9​
10## Extends
11​
12- `OmitKeyof`\<[`UseQueryOptions`](UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"` \| `"enabled"` \| `"throwOnError"` \| `"placeholderData"`\>
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### queryFn?
35​
36```ts
37optional queryFn: QueryFunction<TQueryFnData, TQueryKey, never>;
38```
39​
40Defined in: [preact-query/src/types.ts:90](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L90)
41​
42***
43​
44### subscribed?
45​
46```ts
47optional subscribed: boolean;
48```
49​
50Defined in: [preact-query/src/types.ts:46](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L46)
51​
52Set this to `false` to unsubscribe this observer from updates to the query cache.
53Defaults to `true`.
54​
55#### Inherited from
56​
57```ts
58OmitKeyof.subscribed
59```