style: add notes

style: add notes

Author: inhiblab

packages/hooks/src/useAsyncOrder/__tests__/index.spec.ts

@@ -1,25 +1,25 @@
 import { sleep } from 'test-utils/sleep'
 import { ref } from 'vue'
-import useAsyncOrder from '..'
+import useAsyncOrder from '../index'
 
 function getUsername(): Promise<string> {
-  return new Promise((resolve, reject) => {
+  return new Promise(resolve => {
     setTimeout(() => {
       resolve('第一个数据')
     }, 200)
   })
 }
 
 function getUsername2(): Promise<string> {
-  return new Promise((resolve, reject) => {
+  return new Promise(resolve => {
     setTimeout(() => {
       resolve('第二个数据')
     }, 300)
   })
 }
 
 function getUsername3(): Promise<string> {
-  return new Promise((resolve, reject) => {
+  return new Promise(resolve => {
     setTimeout(() => {
       resolve('第三个数据')
     }, 200)
@@ -54,11 +54,11 @@ describe('useAsyncOrder', async () => {
         },
       ],
       option: {
-        onError: err => {
+        onError: () => {
           error.value += 1
         },
         onSuccess: res => {
-          list.value.push(res)
+          list.value.push(res as string)
         },
       },
     })

packages/hooks/src/useAsyncOrder/demo/demo.vue

@@ -66,7 +66,7 @@
         error.value += 1
       },
       onSuccess: res => {
-        list.value.push(res)
+        list.value.push(res as string)
       },
     },
   })

packages/hooks/src/useAsyncOrder/index.en-US.md

@@ -21,29 +21,29 @@ Hook to manage the execution order of asynchronous tasks
 useAsyncOrder({
   task: ((
 		resolve?: Resolve,
-		reject?: interruptibleRejectType,
+		reject?: InterruptibleRejectType,
 		index?: number
 	) => void)[]
 	option?: {
 		delay?: number
 		onReady?: () => void
-		onSuccess?: (result: any) => void
-		onError?: (err: any) => void
+		onSuccess?: (result: unknown) => void
+		onError?: (err: unknown) => void
 	}})
 ```
 
 ## Params
 
 | Property | Description | Type |
 | --- | --- | --- |
-| task | aynchronous task order queue | `((resolve?: Resolve,reject?: interruptibleRejectType,index?: number) => void)[]` |
+| task | aynchronous task order queue | `((resolve?: Resolve,reject?: InterruptibleRejectType,index?: number) => void)[]` |
 | option | option | - |
 
 ## Option
 
-| Property  | Description                | Type                    |
-| --------- | -------------------------- | ----------------------- |
-| delay     | delay execution            | `number`                |
-| onReady   | Preparation phase callback | `void`                  |
-| onSuccess | successful callback        | `(result: any) => void` |
-| onError   | error callback             | `(err: any) => void`    |
+| Property  | Description                | Type                        |
+| --------- | -------------------------- | --------------------------- |
+| delay     | Delay execution            | `number`                    |
+| onReady   | Preparation phase callback | `void`                      |
+| onSuccess | Successful callback        | `(result: unknown) => void` |
+| onError   | Error callback             | `(err: unknown) => void`    |

packages/hooks/src/useAsyncOrder/index.ts

@@ -1,15 +1,35 @@
 import { useTimeout } from '../index'
 
 export type Resolve = (value: any) => void
-export type interruptibleRejectType = (error: any) => void
+export type InterruptibleRejectType = (error: any) => void
 
 export type AsyncOrder = {
-  task: ((resolve?: Resolve, reject?: interruptibleRejectType, index?: number) => void)[]
+  task: ((resolve?: Resolve, reject?: InterruptibleRejectType, index?: number) => void)[]
   option?: {
+    /**
+     *  Delay execution
+     */
     delay?: number
+
+    /**
+     * Preparation phase callback
+     * @returns void
+     */
     onReady?: () => void
-    onSuccess?: (result: any) => void
-    onError?: (err: any) => void
+
+    /**
+     * Successful callback
+     * @param result any
+     * @returns void
+     */
+    onSuccess?: (result: unknown) => void
+
+    /**
+     * Error callback
+     * @param err unknown
+     * @returns void
+     */
+    onError?: (err: unknown) => void
   }
 }
 
@@ -23,7 +43,7 @@ export default function useAsyncOrder({ task, option }: AsyncOrder) {
     onError?.(reason)
   }
 
-  const interruptibleReject = (resolve: Resolve): interruptibleRejectType => {
+  const interruptibleReject = (resolve: Resolve): InterruptibleRejectType => {
     return (error: any) => {
       interruptibleError(error)
       resolve?.({ error })

packages/hooks/src/useAsyncOrder/index.zh-CN.md

@@ -23,29 +23,29 @@ map:
 useAsyncOrder({
   task: ((
 		resolve?: Resolve,
-		reject?: interruptibleRejectType,
+		reject?: InterruptibleRejectType,
 		index?: number
 	) => void)[]
 	option?: {
 		delay?: number
 		onReady?: () => void
-		onSuccess?: (result: any) => void
-		onError?: (err: any) => void
+		onSuccess?: (result: unknown) => void
+		onError?: (err: unknown) => void
 	}})
 ```
 
 ## Params
 
 | 参数 | 说明 | 类型 |
 | --- | --- | --- |
-| task | 异步任务顺序队列 | `((resolve?: Resolve,reject?: interruptibleRejectType,index?: number) => void)[]` |
+| task | 异步任务顺序队列 | `((resolve?: Resolve,reject?: InterruptibleRejectType,index?: number) => void)[]` |
 | option | 配置项 | - |
 
 ## Option
 
-| 参数      | 说明         | 类型                    |
-| --------- | ------------ | ----------------------- |
-| delay     | 延迟执行     | `number`                |
-| onReady   | 准备阶段回调 | `void`                  |
-| onSuccess | 成功回调     | `(result: any) => void` |
-| onError   | 错误回调     | `(err: any) => void`    |
+| 参数      | 说明         | 类型                        |
+| --------- | ------------ | --------------------------- |
+| delay     | 延迟执行     | `number`                    |
+| onReady   | 准备阶段回调 | `void`                      |
+| onSuccess | 成功回调     | `(result: unknown) => void` |
+| onError   | 错误回调     | `(err: unknown) => void`    |

packages/hooks/src/useBoolean/index.ts

@@ -2,15 +2,37 @@ import type { Ref } from "vue";
 import useToggle from "../useToggle";
 
 export interface Actions {
+    /**
+   *  Set state to `true`
+   * @returns void
+   */
   setTrue: () => void;
+
+  /**
+   *  Set state to `false`
+   * @returns void
+   */
   setFalse: () => void;
+
+  /**
+   * Set state
+   * @param value boolean
+   * @returns void
+   */
   set: (value: boolean) => void;
+
+  /**
+   * Toggle state
+   * @returns void
+   */
   toggle: () => void;
 }
 
+export type UseBooleanResult = [Ref<boolean>, Actions]
+
 export default function useBoolean(
   defaultValue = false
-): [Ref<boolean>, Actions] {
+): UseBooleanResult {
   const [state, { set, toggle }] = useToggle(defaultValue);
   const actions = {
     set: (v: boolean) => set(!!v),

packages/hooks/src/useRequest/plugins/useCachePlugin.ts

@@ -45,9 +45,6 @@ const useCachePlugin: Plugin<unknown, unknown[]> = (
     if (cacheData && Object.hasOwnProperty.call(cacheData, 'data')) {
       fetchInstance.state.data = cacheData.data
       fetchInstance.state.params = cacheData.params
-
-      console.log('staleTime', staleTime)
-
       if (staleTime === -1 || new Date().getTime() - cacheData.time <= staleTime) {
         fetchInstance.state.loading = false
       }
@@ -76,8 +73,6 @@ const useCachePlugin: Plugin<unknown, unknown[]> = (
       }
       // 数据是新鲜就停止请求
       if (staleTime === -1 || new Date().getTime() - cacheData.time <= staleTime) {
-        console.log('停止请求')
-
         return {
           loading: false,
           data: cacheData?.data,