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

experimental_streamedQuery.md

55 lines1.4 KB

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```