katanakit-js / experimental_streamedQuery

Function: experimental_streamedQuery()

function experimental_streamedQuery<TQueryFnData, TData, TQueryKey>(streamFn): (context) => TData | Promise<TData>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/streamedQuery.d.ts:47

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

Type Parameter	Default type
TQueryFnData	unknown
TData	TQueryFnData[]
TQueryKey extends readonly unknown[]	readonly unknown[]

Parameters

Parameter	Type	Description
streamFn	StreamedQueryParams<TQueryFnData, TData, TQueryKey>	The function that returns an AsyncIterable to stream data from.

Returns

(context) => TData | Promise<TData>

Example

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