|
---
|
||
|
|
id: UseSuspenseQueryOptions
|
||
|
|
title: UseSuspenseQueryOptions
|
||
|
|
---
|
||
|
|
|
||
|
|
# Interface: UseSuspenseQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>
|
||
|
|
|
||
|
|
Defined in: [preact-query/src/types.ts:81](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L81)
|
||
|
|
|
||
|
|
## Extends
|
||
|
|
|
||
|
|
- `OmitKeyof`\<[`UseQueryOptions`](UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"` \| `"enabled"` \| `"throwOnError"` \| `"placeholderData"`\>
|
||
|
|
|
||
|
|
## Type Parameters
|
||
|
|
|
||
|
|
### TQueryFnData
|
||
|
|
|
||
|
|
`TQueryFnData` = `unknown`
|
||
|
|
|
||
|
|
### TError
|
||
|
|
|
||
|
|
`TError` = `DefaultError`
|
||
|
|
|
||
|
|
### TData
|
||
|
|
|
||
|
|
`TData` = `TQueryFnData`
|
||
|
|
|
||
|
|
### TQueryKey
|
||
|
|
|
||
|
|
`TQueryKey` *extends* `QueryKey` = `QueryKey`
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
### queryFn?
|
||
|
|
|
||
|
|
```ts
|
||
|
|
optional queryFn: QueryFunction<TQueryFnData, TQueryKey, never>;
|
||
|
|
```
|
||
|
|
|
||
|
|
Defined in: [preact-query/src/types.ts:90](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L90)
|
||
|
|
|
||
|
|
***
|
||
|
|
|
||
|
|
### subscribed?
|
||
|
|
|
||
|
|
```ts
|
||
|
|
optional subscribed: boolean;
|
||
|
|
```
|
||
|
|
|
||
|
|
Defined in: [preact-query/src/types.ts:46](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L46)
|
||
|
|
|
||
|
|
Set this to `false` to unsubscribe this observer from updates to the query cache.
|
||
|
|
Defaults to `true`.
|
||
|
|
|
||
|
|
#### Inherited from
|
||
|
|
|
||
|
|
```ts
|
||
|
|
OmitKeyof.subscribed
|
||
|
|
```
|