* docs(query-core): add missing JSDoc to mutation, retryer, managers, and infinite query behavior * docs(query-core/mutation): note that 'continue' rejects when the resumed mutation fails * docs(framework/*/reference): regenerate reference docs
1.8 KiB
| id | title | redirect_from | |
|---|---|---|---|
| experimental_streamedQuery | experimental_streamedQuery |
|
function experimental_streamedQuery<TQueryFnData, TData, TQueryKey>(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>;
Parameters
context
client
direction?
unknown
Deprecated
if you want access to the direction, you can add it to the pageParam
meta
Record<string, unknown> | undefined
pageParam?
unknown
queryKey
TQueryKey
signal
AbortSignal
Returns
TData | Promise<TData>
Example
await queryClient.query({
queryKey: ['data'],
queryFn: streamedQuery({
streamFn: fetchDataInChunks,
}),
})