packages/query-core/src/__tests__/streamedQuery.test.tsx (1)

519-519: Add a small coverage boost: streamFn returning a Promise.

Your types allow Promise; add a test to lock this in.

+++ a/packages/query-core/src/__tests__/streamedQuery.test.tsx
@@
 describe('streamedQuery', () => {
+  test('should accept streamFn that returns a Promise<AsyncIterable>', async () => {
+    const key = queryKey()
+    const observer = new QueryObserver(queryClient, {
+      queryKey: key,
+      queryFn: streamedQuery({
+        streamFn: async () => Promise.resolve(createAsyncNumberGenerator(2)),
+      }),
+    })
+    const unsubscribe = observer.subscribe(vi.fn())
+    await vi.advanceTimersByTimeAsync(100)
+    expect(observer.getCurrentResult()).toMatchObject({
+      status: 'success',
+      fetchStatus: 'idle',
+      data: [0, 1],
+    })
+    unsubscribe()
+  })
 })

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

examples/react/chat/src/chat.ts (1)

11-24: Optional: honor AbortSignal to avoid running timers after abort/unmount.
Hook into the QueryFunctionContext’s signal so the generator exits early and avoids dangling timeouts.

Apply within the current diff hunk:

-      streamFn: () => chatAnswer(question),
+      streamFn: (ctx) => chatAnswer(question, ctx.signal),

Then adjust the helper (outside this hunk):

function chatAnswer(_question: string, signal?: AbortSignal) {
  return {
    async *[Symbol.asyncIterator]() {
      const answer = answers[Math.floor(Math.random() * answers.length)]
      let index = 0
      while (index < answer.length) {
        // bail out early on abort
        if (signal?.aborted) return
        await new Promise((resolve) => setTimeout(resolve, 100 + Math.random() * 300))
        if (signal?.aborted) return
        yield answer[index++]
      }
    },
  }
}

docs/reference/streamedQuery.md (1)

25-27: Tighten wording for streamFn description.
Minor grammar/style tweak.

-- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
   - **Required**
-  - The function that returns a Promise of an AsyncIterable with data to stream in.
+  - A function that returns a Promise that resolves to an AsyncIterable of chunks to stream.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/reference/streamedQuery.md (1)

29-29: Resolved: closing quote added to refetchMode union.

The unterminated string literal is fixed.

docs/reference/streamedQuery.md (2)

27-27: Tighten wording for clarity (LT flagged).

Current phrasing is a bit clunky; suggest:

-  - The function that returns a Promise of an AsyncIterable with data to stream in.
+  - Returns a Promise that resolves to an AsyncIterable of chunks to stream.

---

41-45: Clarify initialValue line to avoid implying invalid TS syntax and conflicting defaults.

As written, initialValue?: TData = TQueryFnData reads like a type default and also conflicts with “Defaults to an empty array.” Recommend splitting semantics and stating the default plainly.

- - `initialValue?: TData = TQueryFnData`
+ - `initialValue?: TData`
   - Optional
-  - Defines the initial data to be used while the first chunk is being fetched.
+  - Defines the initial data to use while the first chunk is being fetched.
   - It is mandatory when custom `reducer` is provided.
-  - Defaults to an empty array.
+  - Default: an empty array (unless specified).

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.