({
streamFn,
refetchMode = 'reset',
reducer = (items, chunk) =>
addToEnd(items as Array<TQueryFnData>, chunk) as TData,
initialValue = [] as TData,
}: StreamedQueryParams<TQueryFnData, TData, TQueryKey>)
| 71 | * ``` |
| 72 | */ |
| 73 | export function streamedQuery< |
| 74 | TQueryFnData = unknown, |
| 75 | TData = Array<TQueryFnData>, |
| 76 | TQueryKey extends QueryKey = QueryKey, |
| 77 | >({ |
| 78 | streamFn, |
| 79 | refetchMode = 'reset', |
| 80 | reducer = (items, chunk) => |
| 81 | addToEnd(items as Array<TQueryFnData>, chunk) as TData, |
| 82 | initialValue = [] as TData, |
| 83 | }: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction< |
| 84 | TData, |
| 85 | TQueryKey |
| 86 | > { |
| 87 | return async (context) => { |
| 88 | const signalContext: FetchSignalContext = context |
| 89 | const signal = signalContext[fetchSignal] |
| 90 | if (signal?.aborted) { |
| 91 | return initialValue |
| 92 | } |
| 93 | |
| 94 | const query = context.client |
| 95 | .getQueryCache() |
| 96 | .find({ queryKey: context.queryKey, exact: true }) |
| 97 | const isRefetch = !!query && query.isFetched() |
| 98 | if (isRefetch && refetchMode === 'reset') { |
| 99 | query.setState({ |
| 100 | ...query.resetState, |
| 101 | fetchStatus: 'fetching', |
| 102 | }) |
| 103 | } |
| 104 | |
| 105 | let result = initialValue |
| 106 | |
| 107 | let cancelled = false as boolean |
| 108 | const streamFnContext = addConsumeAwareSignal< |
| 109 | OmitKeyof<typeof context, 'signal'> |
| 110 | >( |
| 111 | { |
| 112 | client: context.client, |
| 113 | meta: context.meta, |
| 114 | queryKey: context.queryKey, |
| 115 | pageParam: context.pageParam, |
| 116 | direction: context.direction, |
| 117 | }, |
| 118 | () => context.signal, |
| 119 | () => (cancelled = true), |
| 120 | signal, |
| 121 | ) |
| 122 | |
| 123 | const isStreamInactive = () => cancelled || signal?.aborted === true |
| 124 | const stream = await streamFn(streamFnContext) |
| 125 | |
| 126 | const isReplaceRefetch = isRefetch && refetchMode === 'replace' |
| 127 | |
| 128 | for await (const chunk of stream) { |
| 129 | if (isStreamInactive()) { |
| 130 | break |
no test coverage detected