fix(react-query): Allow optional initialData object in queryOptions (#…

…8162) * fix(react-query): Allow optional initialData in infiniteQueryoptions * fix(react-query): Allow optional initialData object in queryOptions * refactor(react-query): removed unnecessary lines in infiniteQueryOptions test --------- Co-authored-by: chosunghoon <[email protected]>
TanStack · Oct 11, 2024 · 931d98d · 931d98d
1 parent 6469385
commit 931d98d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 6 deletions.
diff --git a/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx b/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx
@@ -158,14 +158,12 @@ describe('infiniteQueryOptions', () => {
     const queryOptions = infiniteQueryOptions({
       queryKey: ['example'],
       queryFn: async () => initialData,
-      // initialData below errors
       initialData: initialData
         ? () => ({ pages: [initialData], pageParams: [] })
         : undefined,
       getNextPageParam: () => 1,
       initialPageParam: 1,
     })
-    queryOptions.initialData
     expectTypeOf(queryOptions.initialData).toMatchTypeOf<
       | InitialDataFunction<InfiniteData<{ example: boolean }, number>>
       | InfiniteData<{ example: boolean }, number>
@@ -178,14 +176,12 @@ describe('infiniteQueryOptions', () => {
     const queryOptions = infiniteQueryOptions({
       queryKey: ['example'],
       queryFn: async () => initialData,
-      // initialData below errors
       initialData: initialData
         ? { pages: [initialData], pageParams: [] }
         : undefined,
       getNextPageParam: () => 1,
       initialPageParam: 1,
     })
-    queryOptions.initialData
     expectTypeOf(queryOptions.initialData).toMatchTypeOf<
       | InitialDataFunction<InfiniteData<{ example: boolean }, number>>
       | InfiniteData<{ example: boolean }, number>

diff --git a/packages/react-query/src/__tests__/queryOptions.test-d.tsx b/packages/react-query/src/__tests__/queryOptions.test-d.tsx
@@ -9,7 +9,10 @@ import { queryOptions } from '../queryOptions'
 import { useQuery } from '../useQuery'
 import { useQueries } from '../useQueries'
 import { useSuspenseQuery } from '../useSuspenseQuery'
-import type { QueryObserverResult } from '@tanstack/query-core'
+import type {
+  InitialDataFunction,
+  QueryObserverResult,
+} from '@tanstack/query-core'
 
 describe('queryOptions', () => {
   it('should not allow excess properties', () => {
@@ -205,4 +208,19 @@ describe('queryOptions', () => {
               },
       })
   })
+
+  it('should allow optional initialData object', () => {
+    const testFn = (id?: string) => {
+      const options = queryOptions({
+        queryKey: ['test'],
+        queryFn: async () => 'something string',
+        initialData: id ? 'initial string' : undefined,
+      })
+      expectTypeOf(options.initialData).toMatchTypeOf<
+        InitialDataFunction<string> | string | undefined
+      >()
+    }
+    testFn('id')
+    testFn()
+  })
 })
diff --git a/packages/react-query/src/infiniteQueryOptions.ts b/packages/react-query/src/infiniteQueryOptions.ts
@@ -48,6 +48,7 @@ export type DefinedInitialDataInfiniteOptions<
   initialData:
     | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
     | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
+    | undefined
 }
 
 export function infiniteQueryOptions<

diff --git a/packages/react-query/src/queryOptions.ts b/packages/react-query/src/queryOptions.ts
@@ -12,7 +12,10 @@ export type UndefinedInitialDataOptions<
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 > = UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
-  initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
+  initialData?:
+    | undefined
+    | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
+    | NonUndefinedGuard<TQueryFnData>
 }
 
 type NonUndefinedGuard<T> = T extends undefined ? never : T