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