0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/react/reference/functions/experimental_streamedQuery.md
Wonsuk Choi 57db962344
docs(*): fix JSDoc '@param' names that don't match the parameters and enforce 'jsdoc/check-param-names' (#11828)
* docs(*): fix JSDoc '@param' names that don't match the parameters

* chore(eslint.config): raise 'jsdoc/check-param-names' to error without requiring destructured properties
2026-10-04 01:57:41 +09:00

1.8 KiB

id title redirect_from
experimental_streamedQuery experimental_streamedQuery
reference/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:69

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

(context: object): TData | Promise<TData>;

Parameters

context

client

QueryClient

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,
  }),
})