Merge pull request #27 from xiachufang/dev

feat: 几个类型补全和useFetchQueueHelper增加run函数

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue3-ts-util",
-  "version": "0.3.34",
+  "version": "0.3.35",
   "main": "dist/index.js",
   "module": "es/src/index.js",
   "types": "es/index.d.ts",

src/GeneralPagination/index.vue.d.ts

@@ -1,24 +1,24 @@
 declare const _default: import("vue").DefineComponent<{
     option: {
-        type: import("vue").PropType<{
+        type: import("vue").PropType<import("..").DeepReadonly<{
             onChange: (page: number) => Promise<void>;
             total: number;
             pageSize: number;
             curr: number;
             setCurr: (v: number) => void;
-        }>;
+        }>>;
         required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
     option?: unknown;
 } & {
-    option: {
+    option: import("..").DeepReadonly<{
         onChange: (page: number) => Promise<void>;
         total: number;
         pageSize: number;
         curr: number;
         setCurr: (v: number) => void;
-    };
+    }>;
 } & {}>, {}>;
 /**
  * @example

src/SearchSelect/index.vue

@@ -8,6 +8,7 @@
     :options="currOptions"
     optionLabelProp="title"
     show-search
+    :mode="mode"
     v-bind="$attrs"
   />
 </template>
@@ -28,7 +29,11 @@ export default defineComponent({
     /**
      * 配置如何将选项转换成显示的文本，值，键
      */
-    conv: customPropType<SearchSelectConv<any>>()
+    conv: customPropType<SearchSelectConv<any>>(),
+    /**
+     * 需要多选加上这个
+     */
+    mode: customPropType<'multiple'>(false)
   },
   setup (props, ctx) {
     const searchTarget = ref('') // 当前搜索目标

src/SearchSelect/index.vue.d.ts

@@ -18,6 +18,12 @@ declare const _default: import("vue").DefineComponent<{
         type: import("vue").PropType<SearchSelectConv<any>>;
         required: true;
     };
+    /**
+     * 需要多选加上这个
+     */
+    mode: {
+        type: import("vue").PropType<"multiple">;
+    };
 }, {
     currOptions: import("vue").ComputedRef<any>;
     onSearch: (target: string) => void;
@@ -27,9 +33,12 @@ declare const _default: import("vue").DefineComponent<{
     value?: unknown;
     options?: unknown;
     conv?: unknown;
+    mode?: unknown;
 } & {
     value: unknown;
     options: any[];
     conv: SearchSelectConv<any>;
-} & {}>, {}>;
+} & {
+    mode?: "multiple" | undefined;
+}>, {}>;
 export default _default;

src/SplitView/index.vue.d.ts

@@ -1,15 +1,12 @@
 declare const _default: import("vue").DefineComponent<{
     percent: {
-        type: import("vue").PropType<number>;
-        required: true;
+        default: number;
     };
     border: {
-        type: import("vue").PropType<boolean>;
-        required: true;
+        default: boolean;
     };
     direction: {
-        type: import("vue").PropType<"vertical" | "horizontal">;
-        required: true;
+        default: "vertical" | "horizontal";
     };
 }, {
     split: Readonly<import("vue").Ref<{
@@ -26,5 +23,9 @@ declare const _default: import("vue").DefineComponent<{
     percent: number;
     border: boolean;
     direction: "vertical" | "horizontal";
-} & {}>, {}>;
+} & {}>, {
+    percent: number;
+    border: boolean;
+    direction: "vertical" | "horizontal";
+}>;
 export default _default;

src/fetchQueue.ts

@@ -215,4 +215,5 @@ export class FetchQueue {
     this.tryRunNext() // 尝试运行刚才压入的任务
     return deepReadonly(task)
   }
+
 }

src/strictQueue.ts

@@ -7,9 +7,6 @@ import { FetchQueue, useFetchQueueHelper } from '.'
  */
 export const strictQueue = (args: ConstructorParameters<typeof FetchQueue> = [1, 0, -1, 'throw']) => {
   const fetchQueue = new FetchQueue(...args)
-  return useFetchQueueHelper(fetchQueue) as {
-    loading: ComputedRef<boolean>
-    fetchQueue: FetchQueue
-  } // 编译时好像有点问题手动指定
+  return useFetchQueueHelper(fetchQueue)
 }
 export const useStrictQueue = strictQueue

src/useFetchQueueHelper.ts

@@ -8,6 +8,9 @@ export const useFetchQueueHelper = (fetchQueue: FetchQueue) => {
   })
   return {
     fetchQueue,
+    async run<R> (action: () => Promise<R>): Promise<R> {
+      return fetchQueue.pushAction(action).res
+    },
     ...deepReadonly({
       loading,
     })

test/FetchQueue/hook.spec.ts

@@ -0,0 +1,17 @@
+/* eslint-disable no-plusplus */
+import { delay, useStrictQueue } from '../../src'
+
+describe('useFetchQueueHelper', () => {
+
+  it('套层皮的简单综合测试', async () => {
+    const { run, loading } = useStrictQueue()
+    expect(loading.value).toBe(false)
+    const r = run(async () => {
+      await delay(100)
+      return 1
+    })
+    expect(loading.value).toBe(true)
+    expect(await r).toBe(1)
+    expect(loading.value).toBe(false)
+  })
+})