fix: types for useSuspenseQuery

TanStack · Jul 20, 2023 · 44cd406 · 44cd406
1 parent 0c0055c
commit 44cd406
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/packages/react-query/src/types.ts b/packages/react-query/src/types.ts
@@ -12,6 +12,7 @@ import type {
   QueryKey,
   QueryObserverOptions,
   QueryObserverResult,
+  QueryObserverSuccessResult,
   WithRequired,
 } from '@tanstack/query-core'
 
@@ -36,6 +37,16 @@ export interface UseQueryOptions<
     'queryKey'
   > {}
 
+export interface UseSuspenseQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+> extends Omit<
+    UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+    'enabled' | 'suspense' | 'throwOnError' | 'placeholderData'
+  > {}
+
 export interface UseInfiniteQueryOptions<
   TQueryFnData = unknown,
   TError = DefaultError,
@@ -65,6 +76,11 @@ export type UseQueryResult<
   TError = DefaultError,
 > = UseBaseQueryResult<TData, TError>
 
+export type UseSuspenseQueryResult<
+  TData = unknown,
+  TError = DefaultError,
+> = Omit<QueryObserverSuccessResult<TData, TError>, 'isPlaceholderData'>
+
 export type DefinedUseQueryResult<
   TData = unknown,
   TError = DefaultError,

diff --git a/packages/react-query/src/useSuspenseQuery.ts b/packages/react-query/src/useSuspenseQuery.ts
@@ -1,22 +1,18 @@
 'use client'
 import { QueryObserver } from '@tanstack/query-core'
 import { useBaseQuery } from './useBaseQuery'
-import type { UseQueryOptions } from './types'
+import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'
 import type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core'
-import type { DefinedUseQueryResult } from './types'
 
 export function useSuspenseQuery<
   TQueryFnData = unknown,
   TError = DefaultError,
   TData = TQueryFnData,
   TQueryKey extends QueryKey = QueryKey,
 >(
-  options: Omit<
-    UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
-    'enabled' | 'suspense' | 'throwOnError' | 'placeholderData'
-  >,
+  options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
   queryClient?: QueryClient,
-): Omit<DefinedUseQueryResult<TData, TError>, 'isPlaceholderData'> {
+): UseSuspenseQueryResult<TData, TError> {
   return useBaseQuery(
     {
       ...options,
@@ -26,5 +22,5 @@ export function useSuspenseQuery<
     },
     QueryObserver,
     queryClient,
-  ) as DefinedUseQueryResult<TData, TError>
+  ) as UseSuspenseQueryResult<TData, TError>
 }