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

experimental_streamedQuery.md

61 lines1.7 KB

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