ref: rename queryFn to streamFn in streamedQuery

TkDodo · TkDodo · commit 98b68c239da2 · 2025-09-01T13:39:51.000+02:00
this avoids the weirdly double-nested queryFn naming
diff --git a/packages/query-core/src/__tests__/streamedQuery.test.tsx b/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
@@ -396,7 +396,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(3),
+        streamFn: () => createAsyncNumberGenerator(3),
         maxChunks: 2,
       }),
     })
@@ -441,7 +441,7 @@ describe('streamedQuery', () => {
     const observer = new QueryObserver(queryClient, {
       queryKey: key,
       queryFn: streamedQuery({
-        queryFn: () => createAsyncNumberGenerator(3),
+        streamFn: () => createAsyncNumberGenerator(3),
         maxChunks: 2,
         refetchMode: 'append',
       }),
diff --git a/packages/query-core/src/streamedQuery.ts b/packages/query-core/src/streamedQuery.ts
@@ -20,11 +20,11 @@ export function streamedQuery<
   TQueryFnData = unknown,
   TQueryKey extends QueryKey = QueryKey,
 >({
-  queryFn,
+  streamFn,
   refetchMode = 'reset',
   maxChunks,
 }: {
-  queryFn: (
+  streamFn: (
     context: QueryFunctionContext<TQueryKey>,
   ) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>
   refetchMode?: 'append' | 'reset' | 'replace'
@@ -46,7 +46,7 @@ export function streamedQuery<
     }
 
     let result: Array<TQueryFnData> = []
-    const stream = await queryFn(context)
+    const stream = await streamFn(context)
 
     for await (const chunk of stream) {
       if (context.signal.aborted) {
