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

experimental_streamedQuery.md

57 lines1.5 KB

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:70](https://github.com/TanStack/query/blob/main/packages/query-core/src/streamedQuery.ts#L70)
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.
18​
19## Type Parameters
20​
21### TQueryFnData
22​
23`TQueryFnData` = `unknown`
24​
25### TData
26​
27`TData` = `TQueryFnData`[]
28​
29### TQueryKey
30​
31`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
32​
33## Parameters
34​
35### options
36​
37`StreamedQueryParams`\<`TQueryFnData`, `TData`, `TQueryKey`\>
38​
39The `streamFn` that returns an AsyncIterable to stream data from, and the optional
40`refetchMode`, `reducer`, and `initialValue` options.
41​
42## Returns
43​
44A query function to pass as `queryFn`.
45​
46(`context`: `object`) => `TData` \| `Promise`\<`TData`\>
47​
48## Example
49​
50```ts
51await queryClient.query({
52 queryKey: ['data'],
53 queryFn: streamedQuery({
54 streamFn: fetchDataInChunks,
55 }),
56})
57```