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