fix: allow optional initialData object (#8157)

Co-authored-by: Dominik Dorfmeister <[email protected]>
TanStack · Oct 9, 2024 · 329b5f8 · 329b5f8
1 parent eb341fc
commit 329b5f8
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx b/packages/react-query/src/__tests__/infiniteQueryOptions.test-d.tsx
@@ -153,7 +153,7 @@ describe('queryOptions', () => {
     queryClient.prefetchQuery(options)
   })
 
-  test('allow optional initialData', () => {
+  test('allow optional initialData function', () => {
     const initialData: { example: boolean } | undefined = { example: true }
     const queryOptions = infiniteQueryOptions({
       queryKey: ['example'],
@@ -168,6 +168,27 @@ describe('queryOptions', () => {
     queryOptions.initialData
     expectTypeOf(queryOptions.initialData).toMatchTypeOf<
       | InitialDataFunction<InfiniteData<{ example: boolean }, number>>
+      | InfiniteData<{ example: boolean }, number>
+      | undefined
+    >()
+  })
+
+  test('allow optional initialData object', () => {
+    const initialData: { example: boolean } | undefined = { example: true }
+    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>
       | undefined
     >()
   })

diff --git a/packages/react-query/src/infiniteQueryOptions.ts b/packages/react-query/src/infiniteQueryOptions.ts
@@ -23,6 +23,7 @@ export type UndefinedInitialDataInfiniteOptions<
 > & {
   initialData?:
     | undefined
+    | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
     | InitialDataFunction<
         NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
       >