upstream-tanstack-query/docs/framework/react/reference/functions/experimental_streamedQuery.md

id, title, redirect_from

id	title	redirect_from
experimental_streamedQuery	experimental_streamedQuery	reference/streamedQuery

function experimental_streamedQuery<TQueryFnData, TData, TQueryKey>(streamFn): QueryFunction<TData, TQueryKey>;

Defined in: packages/query-core/src/streamedQuery.ts:75

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

streamFn

StreamedQueryParams<TQueryFnData, TData, TQueryKey>

The function that returns an AsyncIterable to stream data from.

Returns

QueryFunction<TData, TQueryKey>

Example

await queryClient.query({
  queryKey: ['data'],
  queryFn: streamedQuery({
    streamFn: fetchDataInChunks,
  }),
})