Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ref: rename queryFn to streamFn in streamedQuery #9606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 4, 2025
Merged

ref: rename queryFn to streamFn in streamedQuery #9606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
98b68c2
ref: rename queryFn to streamFn in streamedQuery
TkDodo Sep 1, 2025
8af2be0
chore: docs
TkDodo Sep 3, 2025
23c99d1
Merge branch 'main' into feature/streamFn
TkDodo Sep 3, 2025
cc6628b
merge main
TkDodo Sep 4, 2025
dd12c6c
fix: docs
TkDodo Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/reference/streamedQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { experimental_streamedQuery as streamedQuery } from '@tanstack/react-que
const query = queryOptions({
queryKey: ['data'],
queryFn: streamedQuery({
queryFn: fetchDataInChunks,
streamFn: fetchDataInChunks,
}),
})
```
Expand All @@ -22,11 +22,11 @@ const query = queryOptions({

**Options**

- `queryFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Type parameter mismatch: streamFn should yield TQueryFnData, not TData.

This conflicts with the reducer signature using TQueryFnData for chunks.

Apply this diff:

- - `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
+ - `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TQueryFnData>>`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TQueryFnData>>`
🤖 Prompt for AI Agents 
In docs/reference/streamedQuery.md around line 25, the documented type for
streamFn uses TData but it should yield TQueryFnData to match the reducer
signature; update the signature from `streamFn: (context: QueryFunctionContext)
=> Promise<AsyncIterable<TData>>` to `streamFn: (context: QueryFunctionContext)
=> Promise<AsyncIterable<TQueryFnData>>` (or the equivalent doc representation)
so the type parameter for streamed chunks aligns with the reducer's
TQueryFnData.

- **Required**
- The function that returns a Promise of an AsyncIterable of data to stream in.
- The function that returns a Promise of an AsyncIterable with data to stream in.
- Receives a [QueryFunctionContext](../../framework/react/guides/query-functions.md#queryfunctioncontext)
- `refetchMode?: 'append' | 'reset' | 'replace`
- `refetchMode?: 'append' | 'reset' | 'replace'`
- Optional
- Defines how refetches are handled.
- Defaults to `'reset'`
Expand Down
2 changes: 1 addition & 1 deletion examples/react/chat/src/chat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export const chatQueryOptions = (question: string) =>
queryOptions({
queryKey: ['chat', question],
queryFn: streamedQuery({
queryFn: () => chatAnswer(question),
streamFn: () => chatAnswer(question),
}),
staleTime: Infinity,
})
18 changes: 9 additions & 9 deletions packages/query-core/src/__tests__/streamedQuery.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(3),
streamFn: () => createAsyncNumberGenerator(3),
}),
})

Expand Down Expand Up @@ -78,7 +78,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: async function* () {
streamFn: async function* () {
for await (const num of createAsyncNumberGenerator(3)) {
yield [num, num] as const
}
Expand Down Expand Up @@ -133,7 +133,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(2),
streamFn: () => createAsyncNumberGenerator(2),
}),
})

Expand Down Expand Up @@ -187,7 +187,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(2),
streamFn: () => createAsyncNumberGenerator(2),
refetchMode: 'append',
}),
})
Expand Down Expand Up @@ -243,7 +243,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(2, offset),
streamFn: () => createAsyncNumberGenerator(2, offset),
refetchMode: 'replace',
}),
})
Expand Down Expand Up @@ -300,7 +300,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(3),
streamFn: () => createAsyncNumberGenerator(3),
refetchMode: 'append',
}),
})
Expand Down Expand Up @@ -355,7 +355,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: (context) => {
streamFn: (context) => {
// just consume the signal
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
const numbers = context.signal ? 3 : 0
Expand Down Expand Up @@ -397,7 +397,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(2),
streamFn: () => createAsyncNumberGenerator(2),
reducer: (acc, chunk) => ({
...acc,
[chunk]: true,
Expand Down Expand Up @@ -433,7 +433,7 @@ describe('streamedQuery', () => {
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: streamedQuery({
queryFn: () => createAsyncNumberGenerator(2),
streamFn: () => createAsyncNumberGenerator(2),
reducer: (acc, chunk) => ({
...acc,
[chunk]: true,
Expand Down
6 changes: 3 additions & 3 deletions packages/query-core/src/streamedQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { addToEnd } from './utils'
import type { QueryFunction, QueryFunctionContext, QueryKey } from './types'

type BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {
queryFn: (
streamFn: (
context: QueryFunctionContext<TQueryKey>,
) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>
refetchMode?: 'append' | 'reset' | 'replace'
Expand Down Expand Up @@ -48,7 +48,7 @@ export function streamedQuery<
TData = Array<TQueryFnData>,
TQueryKey extends QueryKey = QueryKey,
>({
queryFn,
streamFn,
refetchMode = 'reset',
reducer = (items, chunk) =>
addToEnd(items as Array<TQueryFnData>, chunk) as TData,
Expand All @@ -73,7 +73,7 @@ export function streamedQuery<

let result = initialValue

const stream = await queryFn(context)
const stream = await streamFn(context)

for await (const chunk of stream) {
if (context.signal.aborted) {
Expand Down
Loading