feat: optimize useRequest data return type of typescript (#239)

InhiblabCore · Jan 24, 2025 · 6c4045d · 6c4045d
1 parent 7f81dff
commit 6c4045d
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 18 deletions.
diff --git a/packages/hooks/src/useRequest/types.ts b/packages/hooks/src/useRequest/types.ts
@@ -283,7 +283,12 @@ export interface UseRequestPlugin<TData, TParams extends unknown[] = unknown[],
   ) => Partial<UseRequestFetchState<TData, TParams>>
 }
 
-export interface useRequestResult<TData, TParams extends unknown[]> {
+export interface useRequestResult<
+  TData,
+  TParams extends unknown[],
+  FormatResult = any,
+  Initial = any
+> {
   /**
    * Is the service being executed.
    */
@@ -292,7 +297,17 @@ export interface useRequestResult<TData, TParams extends unknown[]> {
   /**
    * Data returned by service.
    */
-  data: Readonly<Ref<TData | undefined>>
+  data: Readonly<
+    Ref<
+      FormatResult extends false
+        ? Initial extends false
+          ? TData | undefined
+          : TData
+        : FormatResult extends (...args: any[]) => any
+        ? ReturnType<FormatResult> | undefined
+        : FormatResult | undefined
+    >
+  >
 
   /**
    * 	Exception thrown by service.

diff --git a/packages/hooks/src/useRequest/useRequest.ts b/packages/hooks/src/useRequest/useRequest.ts
@@ -23,7 +23,7 @@ import { withArgs } from './utils/resolve-args'
 export type PluginsMiddleOptionsType<
   PluginsOptions,
   TData,
-  TParams extends unknown[] = unknown[]
+  TParams extends unknown[] = unknown[],
 > = PluginsOptions extends (infer P)[]
   ? P extends UseRequestPlugin<TData, TParams, infer R>
     ? R
@@ -34,8 +34,11 @@ export type PluginsMiddleOptionsType<
 export function useRequest<
   TData,
   TParams extends unknown[] = unknown[],
-  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<TData, TParams>[],
-  SR = any
+  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<
+    TData,
+    TParams
+  >[],
+  SR = any,
 >(
   service: UseRequestService<SR, TParams>,
   options: UseRequestOptionsWithFormatResult<
@@ -46,14 +49,31 @@ export function useRequest<
   > &
     UseRequestOptionsWithInitialData<SR, TParams, PluginsOptions>,
   plugins?: PluginsOptions,
-): useRequestResult<TData, TParams>
+): useRequestResult<
+  TData,
+  TParams,
+  UseRequestOptionsWithFormatResult<
+    TData,
+    TParams,
+    PluginsMiddleOptionsType<PluginsOptions, TData, TParams>,
+    SR
+  >['formatResult'],
+  UseRequestOptionsWithInitialData<
+    TData,
+    TParams,
+    PluginsMiddleOptionsType<PluginsOptions, TData, TParams>
+  >['initialData']
+>
 
 // 只有 formatResult
 export function useRequest<
   TData,
   TParams extends unknown[] = unknown[],
-  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<TData, TParams>[],
-  SR = any
+  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<
+    TData,
+    TParams
+  >[],
+  SR = any,
 >(
   service: UseRequestService<SR, TParams>,
   options: UseRequestOptionsWithFormatResult<
@@ -63,13 +83,26 @@ export function useRequest<
     SR
   >,
   plugins?: PluginsOptions,
-): useRequestResult<TData, TParams>
+): useRequestResult<
+  TData,
+  TParams,
+  UseRequestOptionsWithFormatResult<
+    TData,
+    TParams,
+    PluginsMiddleOptionsType<PluginsOptions, TData, TParams>,
+    SR
+  >['formatResult'],
+  false
+>
 
 // 只有 initialData
 export function useRequest<
   TData,
   TParams extends unknown[] = unknown[],
-  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<TData, TParams>[]
+  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<
+    TData,
+    TParams
+  >[],
 >(
   service: UseRequestService<TData, TParams>,
   options: UseRequestOptionsWithInitialData<
@@ -78,13 +111,25 @@ export function useRequest<
     PluginsMiddleOptionsType<PluginsOptions, TData, TParams>
   >,
   plugins?: PluginsOptions,
-): useRequestResult<TData, TParams>
+): useRequestResult<
+  TData,
+  TParams,
+  false,
+  UseRequestOptionsWithInitialData<
+    TData,
+    TParams,
+    PluginsMiddleOptionsType<PluginsOptions, TData, TParams>
+  >['initialData']
+>
 
 // 无 formatResults 和 initialData
 export function useRequest<
   TData,
   TParams extends unknown[] = unknown[],
-  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<TData, TParams>[]
+  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<
+    TData,
+    TParams
+  >[],
 >(
   service: UseRequestService<TData, TParams>,
   options?: UseRequestOptions<
@@ -93,12 +138,15 @@ export function useRequest<
     PluginsMiddleOptionsType<PluginsOptions, TData, TParams>
   >,
   plugins?: PluginsOptions,
-): useRequestResult<TData, TParams>
+): useRequestResult<TData, TParams, false, false>
 
 export function useRequest<
   TData,
   TParams extends unknown[] = unknown[],
-  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<TData, TParams>[]
+  PluginsOptions extends UseRequestPlugin<TData, TParams>[] = UseRequestPlugin<
+    TData,
+    TParams
+  >[],
 >(
   service: UseRequestService<TData, TParams>,
   options?: UseRequestOptions<
@@ -120,10 +168,14 @@ export function useRequest<
     useRetryPlugin,
   ]?.filter(Boolean)
 
-  return withArgs<TData, TParams>(useRequestImplement, options?.use)(service, options, [
-    ...(plugins || []),
-    ...BuiltInPlugins,
-  ] as UseRequestPlugin<TData, TParams>[])
+  return withArgs<TData, TParams>(useRequestImplement, options?.use)(
+    service,
+    options,
+    [...(plugins || []), ...BuiltInPlugins] as UseRequestPlugin<
+      TData,
+      TParams
+    >[],
+  )
 }
 
 export default useRequest