feat: compatible error

Author: liaoliao666

src/createInfiniteQuery.ts

@@ -1,12 +1,16 @@
 import { useInfiniteQuery } from '@tanstack/react-query'
 
 import { createBaseQuery } from './createBaseQuery'
-import type { CreateInfiniteQueryOptions, InfiniteQueryHook } from './types'
+import type {
+  CompatibleError,
+  CreateInfiniteQueryOptions,
+  InfiniteQueryHook,
+} from './types'
 
 export const createInfiniteQuery = <
   TFnData,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 >(
   options: CreateInfiniteQueryOptions<TFnData, TVariables, TError, TPageParam>

src/createMutation.ts

@@ -1,12 +1,16 @@
 import { useMutation } from '@tanstack/react-query'
 
-import type { CreateMutationOptions, MutationHook } from './types'
+import type {
+  CompatibleError,
+  CreateMutationOptions,
+  MutationHook,
+} from './types'
 import { withMiddleware } from './utils'
 
 export const createMutation = <
   TData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TContext = unknown
 >(
   defaultOptions: CreateMutationOptions<TData, TVariables, TError, TContext>

src/createQuery.tsx

@@ -1,9 +1,13 @@
 import { useQuery } from '@tanstack/react-query'
 
 import { createBaseQuery } from './createBaseQuery'
-import type { CreateQueryOptions, QueryHook } from './types'
+import type { CompatibleError, CreateQueryOptions, QueryHook } from './types'
 
-export const createQuery = <TFnData, TVariables = void, TError = Error>(
+export const createQuery = <
+  TFnData,
+  TVariables = void,
+  TError = CompatibleError
+>(
   options: CreateQueryOptions<TFnData, TVariables, TError>
 ): QueryHook<TFnData, TVariables, TError> => {
   return createBaseQuery(options, useQuery)

src/createSuspenseInfiniteQuery.ts

@@ -2,6 +2,7 @@ import { useInfiniteQuery } from '@tanstack/react-query'
 
 import { createBaseQuery } from './createBaseQuery'
 import type {
+  CompatibleError,
   CreateSuspenseInfiniteQueryOptions,
   SuspenseInfiniteQueryHook,
 } from './types'
@@ -10,7 +11,7 @@ import { suspenseOptions } from './utils'
 export const createSuspenseInfiniteQuery = <
   TFnData,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 >(
   options: CreateSuspenseInfiniteQueryOptions<

src/createSuspenseQuery.ts

@@ -1,10 +1,18 @@
 import { useQuery } from '@tanstack/react-query'
 
 import { createBaseQuery } from './createBaseQuery'
-import type { CreateSuspenseQueryOptions, SuspenseQueryHook } from './types'
+import type {
+  CompatibleError,
+  CreateSuspenseQueryOptions,
+  SuspenseQueryHook,
+} from './types'
 import { suspenseOptions } from './utils'
 
-export const createSuspenseQuery = <TFnData, TVariables = void, TError = Error>(
+export const createSuspenseQuery = <
+  TFnData,
+  TVariables = void,
+  TError = CompatibleError
+>(
   options: CreateSuspenseQueryOptions<TFnData, TVariables, TError>
 ): SuspenseQueryHook<TFnData, TVariables, TError> => {
   return createBaseQuery(options, useQuery, suspenseOptions)

src/types.ts

@@ -1,4 +1,5 @@
 import type {
+  DefaultError,
   DefinedUseQueryResult,
   GetNextPageParamFunction,
   GetPreviousPageParamFunction,
@@ -90,6 +91,8 @@ type WithRequired<T, K extends keyof T> = T & {
   [_ in K]: {}
 }
 
+export type CompatibleError = CompatibleWithV4<DefaultError, Error>
+
 export type inferQueryKey<TVariables> = TVariables extends void
   ? [string]
   : [string, TVariables]
@@ -161,7 +164,7 @@ export type ExposeMethods<TFnData, TVariables, TPageParam = never> = {
 export interface CreateQueryOptions<
   TFnData = unknown,
   TVariables = void,
-  TError = Error
+  TError = CompatibleError
 > extends Omit<
       UseQueryOptions<TFnData, TError, TFnData, inferQueryKey<TVariables>>,
       'queryKey' | 'queryFn' | 'select'
@@ -194,8 +197,11 @@ export type DefinedQueryHookResult<TData, TError> = DefinedUseQueryResult<
   TError
 >
 
-export interface QueryHook<TFnData = unknown, TVariables = any, TError = Error>
-  extends ExposeMethods<TFnData, TVariables> {
+export interface QueryHook<
+  TFnData = unknown,
+  TVariables = any,
+  TError = CompatibleError
+> extends ExposeMethods<TFnData, TVariables> {
   <TData = TFnData>(
     options: DefinedQueryHookOptions<TFnData, TError, TData, TVariables>,
     queryClient?: CompatibleWithV4<QueryClient, void>
@@ -211,7 +217,7 @@ export interface QueryHook<TFnData = unknown, TVariables = any, TError = Error>
 export interface CreateSuspenseQueryOptions<
   TFnData = unknown,
   TVariables = void,
-  TError = Error
+  TError = CompatibleError
 > extends Omit<
       UseQueryOptions<TFnData, TError, TFnData, inferQueryKey<TVariables>>,
       | 'queryKey'
@@ -253,7 +259,7 @@ export type SuspenseQueryHookResult<TData, TError> = Omit<
 export interface SuspenseQueryHook<
   TFnData = unknown,
   TVariables = void,
-  TError = Error
+  TError = CompatibleError
 > extends ExposeMethods<TFnData, TVariables> {
   <TData = TFnData>(
     options?: SuspenseQueryHookOptions<TFnData, TError, TData, TVariables>,
@@ -266,7 +272,7 @@ export interface SuspenseQueryHook<
 export interface CreateInfiniteQueryOptions<
   TFnData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 > extends Omit<
       CompatibleUseInfiniteQueryOptions<
@@ -335,7 +341,7 @@ export type DefinedInfiniteQueryHookResult<TData, TError> = WithRequired<
 export interface InfiniteQueryHook<
   TFnData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 > extends ExposeMethods<TFnData, TVariables, TPageParam> {
   <TData = CompatibleWithV4<InfiniteData<TFnData, TPageParam>, TFnData>>(
@@ -365,7 +371,7 @@ export interface InfiniteQueryHook<
 export interface CreateSuspenseInfiniteQueryOptions<
   TFnData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 > extends Omit<
       CompatibleUseInfiniteQueryOptions<
@@ -428,7 +434,7 @@ export type SuspenseInfiniteQueryHookResult<TData, TError> = Omit<
 export interface SuspenseInfiniteQueryHook<
   TFnData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TPageParam = number
 > extends ExposeMethods<TFnData, TVariables, TPageParam> {
   <TData = CompatibleWithV4<InfiniteData<TFnData, TPageParam>, TFnData>>(
@@ -448,7 +454,7 @@ export interface SuspenseInfiniteQueryHook<
 export interface CreateMutationOptions<
   TData = unknown,
   TVariables = void,
-  TError = Error,
+  TError = CompatibleError,
   TContext = unknown
 > extends UseMutationOptions<TData, TError, TVariables, TContext> {
   use?: Middleware<MutationHook<TData, TError, TVariables>>[]
@@ -465,7 +471,7 @@ export interface MutationHookOptions<TData, TError, TVariables, TContext>
 
 export type MutationHookResult<
   TData = unknown,
-  TError = Error,
+  TError = CompatibleError,
   TVariables = void,
   TContext = unknown
 > = UseMutationResult<TData, TError, TVariables, TContext>