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

UseSuspenseInfiniteQueryOptions.md

63 lines1.3 KB

1---
2id: UseSuspenseInfiniteQueryOptions
3title: UseSuspenseInfiniteQueryOptions
4---
5​
6# Interface: UseSuspenseInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryKey, TPageParam\>
7​
8Defined in: [preact-query/src/types.ts:128](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L128)
9​
10## Extends
11​
12- `OmitKeyof`\<[`UseInfiniteQueryOptions`](UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"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### TPageParam
33​
34`TPageParam` = `unknown`
35​
36## Properties
37​
38### queryFn?
39​
40```ts
41optional queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;
42```
43​
44Defined in: [preact-query/src/types.ts:138](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L138)
45​
46***
47​
48### subscribed?
49​
50```ts
51optional subscribed: boolean;
52```
53​
54Defined in: [preact-query/src/types.ts:123](https://github.com/theVedanta/query/blob/main/packages/preact-query/src/types.ts#L123)
55​
56Set this to `false` to unsubscribe this observer from updates to the query cache.
57Defaults to `true`.
58​
59#### Inherited from
60​
61```ts
62OmitKeyof.subscribed
63```