Open History to see the last commit
1---
2id: experimental_streamedQuery
3title: experimental_streamedQuery
4---
5β
6```ts
7function experimental_streamedQuery<TQueryFnData, TData, TQueryKey>(options: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): (context: object) => TData | Promise<TData>;
8```
9β
10Defined in: [packages/query-core/src/streamedQuery.ts:70](https://github.com/TanStack/query/blob/main/packages/query-core/src/streamedQuery.ts#L70)
11β
12This is a helper function to create a query function that streams data from an AsyncIterable.
13Data will be an Array of all the chunks received.
14The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
15The query will stay in fetchStatus 'fetching' until the stream ends.
16β
17## Type Parameters
18β
19### TQueryFnData
20β
21`TQueryFnData` = `unknown`
22β
23### TData
24β
25`TData` = `TQueryFnData`[]
26β
27### TQueryKey
28β
29`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
30β
31## Parameters
32β
33### options
34β
35`StreamedQueryParams`\<`TQueryFnData`, `TData`, `TQueryKey`\>
36β
37The `streamFn` that returns an AsyncIterable to stream data from, and the optional
38`refetchMode`, `reducer`, and `initialValue` options.
39β
40## Returns
41β
42A query function to pass as `queryFn`.
43β
44(`context`: `object`) => `TData` \| `Promise`\<`TData`\>
45β
46## Example
47β
48```ts
49await queryClient.query({
50 queryKey: ['data'],
51 queryFn: streamedQuery({
52 streamFn: fetchDataInChunks,
53 }),
54})
55```