fix(query-options): allow returning undefined in initialData function (…

…#7351) * Fix PR * Fix for react adapter * ci: apply automated fixes --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
TanStack · Aug 1, 2024 · fdb8ce1 · fdb8ce1
1 parent 5ab13b9
commit fdb8ce1
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 4 deletions.
diff --git a/packages/angular-query-experimental/src/__tests__/query-options.test-d.ts b/packages/angular-query-experimental/src/__tests__/query-options.test-d.ts
@@ -22,6 +22,25 @@ describe('queryOptions', () => {
       },
     })
   })
+
+  test('should allow undefined response in initialData', () => {
+    return (id: string | null) =>
+      queryOptions({
+        queryKey: ['todo', id],
+        queryFn: () =>
+          Promise.resolve({
+            id: '1',
+            title: 'Do Laundry',
+          }),
+        initialData: () =>
+          !id
+            ? undefined
+            : {
+                id,
+                title: 'Initial Data',
+              },
+      })
+  })
 })
 
 test('should work when passed to injectQuery', () => {

diff --git a/packages/angular-query-experimental/src/query-options.ts b/packages/angular-query-experimental/src/query-options.ts
@@ -1,4 +1,9 @@
-import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
+import type {
+  DataTag,
+  DefaultError,
+  InitialDataFunction,
+  QueryKey,
+} from '@tanstack/query-core'
 import type { CreateQueryOptions, NonUndefinedGuard } from './types'
 
 /**
@@ -10,7 +15,7 @@ export type UndefinedInitialDataOptions<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  initialData?: undefined
+  initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
 }
 
 /**

diff --git a/packages/react-query/src/__tests__/queryOptions.test-d.tsx b/packages/react-query/src/__tests__/queryOptions.test-d.tsx
@@ -186,4 +186,23 @@ describe('queryOptions', () => {
       QueriesObserver<Array<QueryObserverResult>>
     >()
   })
+
+  it('should allow undefined response in initialData', () => {
+    return (id: string | null) =>
+      queryOptions({
+        queryKey: ['todo', id],
+        queryFn: () =>
+          Promise.resolve({
+            id: '1',
+            title: 'Do Laundry',
+          }),
+        initialData: () =>
+          !id
+            ? undefined
+            : {
+                id,
+                title: 'Initial Data',
+              },
+      })
+  })
 })
diff --git a/packages/react-query/src/queryOptions.ts b/packages/react-query/src/queryOptions.ts
@@ -1,4 +1,9 @@
-import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
+import type {
+  DataTag,
+  DefaultError,
+  InitialDataFunction,
+  QueryKey,
+} from '@tanstack/query-core'
 import type { UseQueryOptions } from './types'
 
 export type UndefinedInitialDataOptions<
@@ -7,7 +12,7 @@ export type UndefinedInitialDataOptions<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  initialData?: undefined
+  initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
 }
 
 type NonUndefinedGuard<T> = T extends undefined ? never : T