ref: rename queryFn to streamFn in streamedQuery (#9606)

* ref: rename queryFn to streamFn in streamedQuery

this avoids the weirdly double-nested queryFn naming

* chore: docs

* fix: docs

Author: TkDodo

docs/reference/streamedQuery.md

@@ -13,7 +13,7 @@ import { experimental_streamedQuery as streamedQuery } from '@tanstack/react-que
 const query = queryOptions({
   queryKey: ['data'],
   queryFn: streamedQuery({
-    queryFn: fetchDataInChunks,
+    streamFn: fetchDataInChunks,
   }),
 })
 ```
@@ -22,11 +22,11 @@ const query = queryOptions({
 
 **Options**
 
-- `queryFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
+- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
   - **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'`

examples/react/chat/src/chat.ts

@@ -27,7 +27,7 @@ export const chatQueryOptions = (question: string) =>
   queryOptions({
     queryKey: ['chat', question],
     queryFn: streamedQuery({
-      queryFn: () => chatAnswer(question),
+      streamFn: () => chatAnswer(question),
     }),
     staleTime: Infinity,
   })

packages/query-core/src/__tests__/streamedQuery.test.tsx

@@ -34,7 +34,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(3),
+        streamFn: () => createAsyncNumberGenerator(3),
       }),
     })
 
@@ -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
           }
@@ -133,7 +133,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(2),
+        streamFn: () => createAsyncNumberGenerator(2),
       }),
     })
 
@@ -187,7 +187,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(2),
+        streamFn: () => createAsyncNumberGenerator(2),
         refetchMode: 'append',
       }),
     })
@@ -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',
       }),
     })
@@ -300,7 +300,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(3),
+        streamFn: () => createAsyncNumberGenerator(3),
         refetchMode: 'append',
       }),
     })
@@ -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
@@ -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,
@@ -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,

packages/query-core/src/streamedQuery.ts

@@ -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'
@@ -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,
@@ -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) {