mirror of
https://github.com/hanzoai/agency.git
synced 2026-11-02 19:13:28 +00:00
35 lines
2.3 KiB
Plaintext
35 lines
2.3 KiB
Plaintext
import { I as QueryKey, a1 as QueryFunctionContext, Y as QueryFunction } from './hydration-uphG6M-i.cjs';
|
|
import './removable.cjs';
|
|
import './subscribable.cjs';
|
|
|
|
type BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {
|
|
streamFn: (context: QueryFunctionContext<TQueryKey>) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>;
|
|
refetchMode?: 'append' | 'reset' | 'replace';
|
|
};
|
|
type SimpleStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {
|
|
reducer?: never;
|
|
initialValue?: never;
|
|
};
|
|
type ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {
|
|
reducer: (acc: TData, chunk: TQueryFnData) => TData;
|
|
initialValue: TData;
|
|
};
|
|
type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = SimpleStreamedQueryParams<TQueryFnData, TQueryKey> | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>;
|
|
/**
|
|
* 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.
|
|
* @param queryFn - The function that returns an AsyncIterable to stream data from.
|
|
* @param refetchMode - Defines how re-fetches are handled.
|
|
* Defaults to `'reset'`, erases all data and puts the query back into `pending` state.
|
|
* Set to `'append'` to append new data to the existing data.
|
|
* Set to `'replace'` to write all data to the cache once the stream ends.
|
|
* @param reducer - A function to reduce the streamed chunks into the final data.
|
|
* Defaults to a function that appends chunks to the end of the array.
|
|
* @param initialValue - Initial value to be used while the first chunk is being fetched, and returned if the stream yields no values.
|
|
*/
|
|
declare function streamedQuery<TQueryFnData = unknown, TData = Array<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>({ streamFn, refetchMode, reducer, initialValue, }: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<TData, TQueryKey>;
|
|
|
|
export { streamedQuery };
|