mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults * chore(*): update '@tanstack/typedoc-config' to v0.3.5
1.6 KiB
1.6 KiB
| id | title | redirect_from | |
|---|---|---|---|
| experimental_streamedQuery | experimental_streamedQuery |
|
function experimental_streamedQuery<TQueryFnData = unknown, TData = TQueryFnData[], TQueryKey extends readonly unknown[] = readonly unknown[]>(options: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): (context: object) => TData | Promise<TData>;
Defined in: packages/query-core/src/streamedQuery.ts:70
This is a helper function to create a query function that streams data from an AsyncIterable. 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.
Type Parameters
TQueryFnData
TQueryFnData = unknown
TData
TData = TQueryFnData[]
TQueryKey
TQueryKey extends readonly unknown[] = readonly unknown[]
Parameters
options
StreamedQueryParams<TQueryFnData, TData, TQueryKey>
The streamFn that returns an AsyncIterable to stream data from, and the optional
refetchMode, reducer, and initialValue options.
Returns
A query function to pass as queryFn.
(context: object) => TData | Promise<TData>
Example
await queryClient.query({
queryKey: ['data'],
queryFn: streamedQuery({
streamFn: fetchDataInChunks,
}),
})