Open History to see the last commit
1---
2id: streamedQuery
3title: streamedQuery
4---
5β
6`streamedQuery` is a helper function to create a query function that streams data from an [AsyncIterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator). Data will be an Array of all the chunks received. The query will be in a `pending` state until the first chunk of data is received, but will go to `success` after that. The query will stay in fetchStatus `fetching` until the stream ends.
7β
8```tsx
9const query = queryOptions({
10 queryKey: ['data'],
11 queryFn: streamedQuery({
12 queryFn: fetchDataInChunks,
13 }),
14})
15```
16β
17**Options**
18β
19- `queryFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
20 - **Required**
21 - The function that returns a Promise of an AsyncIterable of data to stream in.
22 - Receives a [QueryFunctionContext](../guides/query-functions.md#queryfunctioncontext)
23- `refetchMode?: 'append' | 'reset'`
24 - optional
25 - when set to `'reset'`, the query will erase all data and go back into `pending` state when a refetch occurs.
26 - when set ot `'append'`, data will be appended on a refetch.
27 - defaults to `'reset'`