From 44cd406f13f315c162a400d61bfa2ab732fbdb88 Mon Sep 17 00:00:00 2001 From: Jonghyeon Ko Date: Fri, 21 Jul 2023 03:29:31 +0900 Subject: [PATCH] fix: types for useSuspenseQuery --- packages/react-query/src/types.ts | 16 ++++++++++++++++ packages/react-query/src/useSuspenseQuery.ts | 12 ++++-------- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/packages/react-query/src/types.ts b/packages/react-query/src/types.ts index d5ffaef598..a2a2187046 100644 --- 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, + 'enabled' | 'suspense' | 'throwOnError' | 'placeholderData' + > {} + export interface UseInfiniteQueryOptions< TQueryFnData = unknown, TError = DefaultError, @@ -65,6 +76,11 @@ export type UseQueryResult< TError = DefaultError, > = UseBaseQueryResult +export type UseSuspenseQueryResult< + TData = unknown, + TError = DefaultError, +> = Omit, 'isPlaceholderData'> + export type DefinedUseQueryResult< TData = unknown, TError = DefaultError, diff --git a/packages/react-query/src/useSuspenseQuery.ts b/packages/react-query/src/useSuspenseQuery.ts index 52f10eb5fe..1b25892542 100644 --- a/packages/react-query/src/useSuspenseQuery.ts +++ b/packages/react-query/src/useSuspenseQuery.ts @@ -1,9 +1,8 @@ '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, @@ -11,12 +10,9 @@ export function useSuspenseQuery< TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( - options: Omit< - UseQueryOptions, - 'enabled' | 'suspense' | 'throwOnError' | 'placeholderData' - >, + options: UseSuspenseQueryOptions, queryClient?: QueryClient, -): Omit, 'isPlaceholderData'> { +): UseSuspenseQueryResult { return useBaseQuery( { ...options, @@ -26,5 +22,5 @@ export function useSuspenseQuery< }, QueryObserver, queryClient, - ) as DefinedUseQueryResult + ) as UseSuspenseQueryResult }