style: 🎨 notes & type prefix

Author: NelsonYong

packages/hooks/src/useRequest/__tests__/plugin.spec.ts

@@ -1,7 +1,7 @@
 import { sleep } from 'test-utils/sleep'
 import renderHook from 'test-utils/renderHook'
 
-import { Plugin } from '../types'
+import { UseRequestPlugin } from '../types'
 import useRequest from '../useRequest'
 
 function getUsername(): Promise<{ name: string; age: number }> {
@@ -15,7 +15,7 @@ function getUsername(): Promise<{ name: string; age: number }> {
   })
 }
 
-const useFormatterPlugin: Plugin<
+const useFormatterPlugin: UseRequestPlugin<
   {
     name: string
     age: number

packages/hooks/src/useRequest/docs/pluginDoc/demo/demo.vue

@@ -6,7 +6,7 @@
 <script lang="ts" setup>
   import { useRequest } from 'vue-hooks-plus'
 
-  import { Plugin } from '../../../types'
+  import { UseRequestPlugin } from '../../../types'
 
   interface FormatterDataType {
     name: string
@@ -17,7 +17,7 @@
     (data?: FormatterDataType): { name: string; age: number }
   }
 
-  const useFormatterPlugin: Plugin<
+  const useFormatterPlugin: UseRequestPlugin<
     FormatterDataType,
     [],
     {

packages/hooks/src/useRequest/types.ts

@@ -242,7 +242,7 @@ export interface UseRequestPlugin<TData, TParams extends unknown[] = unknown[],
   ) => Partial<UseRequestFetchState<TData, TParams>>
 }
 
-export interface Result<TData, TParams extends unknown[]> {
+export interface useRequestResult<TData, TParams extends unknown[]> {
   /**
    * Is the service being executed.
    */

packages/hooks/src/useRequest/useRequestImplement.ts

@@ -1,7 +1,7 @@
 import { ref, reactive, toRefs, onMounted, onUnmounted, unref } from 'vue'
 
 import Fetch from './Fetch'
-import { UseRequestOptions, UseRequestPlugin, Result, UseRequestService } from './types'
+import { UseRequestOptions, UseRequestPlugin, useRequestResult, UseRequestService } from './types'
 
 function useRequestImplement<TData, TParams extends any[]>(
   service: UseRequestService<TData, TParams>,
@@ -81,7 +81,7 @@ function useRequestImplement<TData, TParams extends any[]>(
     run: fetchInstance.run.bind(fetchInstance),
     runAsync: fetchInstance.runAsync.bind(fetchInstance),
     mutate: fetchInstance.mutate.bind(fetchInstance),
-  } as unknown) as Result<TData, TParams>
+  } as unknown) as useRequestResult<TData, TParams>
 }
 
 export default useRequestImplement

packages/hooks/src/useWebSocket/index.ts

@@ -20,7 +20,7 @@ export interface UseWebSocketOptions {
   protocols?: string | string[]
 }
 
-export interface Result {
+export interface UseWebSocketResult {
   latestMessage?: Ref<WebSocketEventMap['message']>
   sendMessage?: WebSocket['send']
   disconnect?: () => void
@@ -37,7 +37,7 @@ export interface Result {
 export default function useWebSocket(
   socketUrl: Ref<string> | string,
   options: UseWebSocketOptions = {},
-): Result {
+): UseWebSocketResult {
   const {
     reconnectLimit = 3,
     reconnectInterval = 3 * 1000,
@@ -163,7 +163,7 @@ export default function useWebSocket(
   })
 
   return {
-    latestMessage: latestMessage as Result['latestMessage'],
+    latestMessage: latestMessage as UseWebSocketResult['latestMessage'],
     sendMessage,
     connect,
     disconnect,