vue-asyncx 1.0.3 → 1.1.0

package/README.md

@@ -1,3 +1,10 @@
+## 特性
+
+- 异步函数样板代码减少50%
+- 异步函数相关的函数、变量命名风格统一
+- 良好的 ts 提示支持
+- 单元测试覆盖率 100% 
+
 ## 开始
 
 ### 安装
@@ -15,8 +22,8 @@ import { submitOrder } from '@/api'
 import { useAsync } from 'vue-asyncx'
 
 /**
- * 函数 submit、加载状态 submitLoading
- * 随着 useAsync('submit', ...) 调用自动提示
+ * 调用 useAsync('submit', ...)，
+ * submit、submitLoading 自动提示
  */
 const { 
   submit, 
@@ -33,8 +40,8 @@ import { getUserById } from '@/api'
 import { useAsyncData } from 'vue-asyncx'
 
 /**
- * 变量 user、加载状态 queryUserLoading、函数 queryUser
- * 随着 useAsyncData('user', ...) 调用自动提示
+ * 调用 useAsyncData('user', ...)，
+ * user、queryUserLoading、queryUser 自动提示
  */
 const { 
   user, 
@@ -42,15 +49,3 @@ const {
   queryUser 
 } = useAsyncData('user', () => getUserById('1'), { immediate: true })
 ```
-
-### 优势
-
-- 单测覆盖率100%
-- 在大型项目中统一对下列三者的命名，使项目具备更好的维护性
-  - 异步函数
-  - 异步函数调用加载状态
-  - 异步函数获取的数据
-- 通过 ts 提示，函数与变量声明过程无感，直观
-- 代码编写过程思路流畅
-  - 从需要 `submit` 函数开始，书写 `useAsync('submit', ...)`，后续解构均有提示辅助
-  - 类似的，从需要 `user` 变量开始，书写 `useAsyncData('user', ...)`，后续变量、方法、加载变量均自动提示

package/dist/vue-asyncx.d.ts

@@ -1,4 +1,5 @@
 import { Ref } from 'vue';
+import { WatchOptions } from 'vue';
 import { WatchSource } from 'vue';
 
 declare type StringDefaultWhenEmpty<S extends string, D extends string> = S extends '' ? D : S;
@@ -20,8 +21,9 @@ declare type UseAsyncDataResult<Fn extends (...args: any) => any, DataName exten
 };
 
 declare type UseAsyncOptions = {
-    immediate?: boolean;
     watch?: WatchSource;
+    watchOptions?: WatchOptions;
+    immediate?: boolean;
 };
 
 declare type UseAsyncResult<Fn extends Function, Name extends string> = {

package/dist/vue-asyncx.js

@@ -1,42 +1,64 @@
-import { ref as a, watch as y } from "vue";
-function l(...e) {
-  if (!Array.isArray(e) || !e.length) throw TypeError("参数错误：未传递");
-  const { name: t, fn: r, options: n } = typeof e[0] == "function" ? { name: "method", fn: e[0], options: e[1] } : { name: e[0] || "method", fn: e[1], options: e[2] };
+var h = Object.defineProperty, d = Object.defineProperties;
+var w = Object.getOwnPropertyDescriptors;
+var p = Object.getOwnPropertySymbols;
+var A = Object.prototype.hasOwnProperty, E = Object.prototype.propertyIsEnumerable;
+var u = (n, t, o) => t in n ? h(n, t, { enumerable: !0, configurable: !0, writable: !0, value: o }) : n[t] = o, m = (n, t) => {
+  for (var o in t || (t = {}))
+    A.call(t, o) && u(n, o, t[o]);
+  if (p)
+    for (var o of p(t))
+      E.call(t, o) && u(n, o, t[o]);
+  return n;
+}, y = (n, t) => d(n, w(t));
+import { ref as l, watch as T } from "vue";
+function v(...n) {
+  var a;
+  if (!Array.isArray(n) || !n.length) throw TypeError("参数错误：未传递");
+  const { name: t, fn: o, options: r } = typeof n[0] == "function" ? { name: "method", fn: n[0], options: n[1] } : { name: n[0] || "method", fn: n[1], options: n[2] };
   if (typeof t != "string") throw TypeError("参数错误：name");
-  if (typeof r != "function") throw TypeError("参数错误：fn");
-  const o = a(!1);
-  function f(...u) {
-    o.value = !0;
-    const i = r(...u);
-    return i instanceof Promise ? i.finally(() => o.value = !1) : o.value = !1, i;
+  if (typeof o != "function") throw TypeError("参数错误：fn");
+  const i = l(!1);
+  function s(...f) {
+    i.value = !0;
+    const e = o(...f);
+    return e instanceof Promise ? e.finally(() => i.value = !1) : i.value = !1, e;
   }
-  return n != null && n.watch ? y(n.watch, () => f(), { immediate: n == null ? void 0 : n.immediate }) : n != null && n.immediate && f(), {
-    [t]: f,
-    [`${t}Loading`]: o
+  if (r) {
+    const f = () => {
+    }, e = Object.assign(
+      {},
+      "immediate" in r ? { immediate: r.immediate } : {},
+      (a = r.watchOptions) != null ? a : {}
+    ), { watch: c } = r;
+    T(c != null ? c : f, () => s(), e);
+  }
+  return {
+    [t]: s,
+    [`${t}Loading`]: i
   };
 }
-function p(e) {
-  if (!e) return "";
-  const t = e[0], r = e.slice(1);
-  return t.toUpperCase() + r;
+function O(n) {
+  if (!n) return "";
+  const t = n[0], o = n.slice(1);
+  return t.toUpperCase() + o;
 }
-function h(...e) {
-  if (!Array.isArray(e) || !e.length) throw TypeError("参数错误：未传递");
-  const { name: t, fn: r, options: n } = typeof e[0] == "function" ? { name: "data", fn: e[0], options: e[1] } : { name: e[0] || "data", fn: e[1], options: e[2] };
+function $(...n) {
+  if (!Array.isArray(n) || !n.length) throw TypeError("参数错误：未传递");
+  const { name: t, fn: o, options: r } = typeof n[0] == "function" ? { name: "data", fn: n[0], options: n[1] } : { name: n[0] || "data", fn: n[1], options: n[2] };
   if (typeof t != "string") throw TypeError("参数错误：name");
-  if (typeof r != "function") throw TypeError("参数错误：fn");
-  const o = a();
-  function f(...i) {
-    const c = r(...i);
-    return c instanceof Promise ? c.then((m) => o.value = m) : o.value = c, c;
+  if (typeof o != "function") throw TypeError("参数错误：fn");
+  const i = l();
+  function s(...f) {
+    const e = o(...f);
+    return e instanceof Promise ? e.then((c) => i.value = c) : i.value = e, e;
   }
-  return {
-    ...l(`query${p(t)}`, f, n),
-    [t]: o
-  };
+  const a = v(`query${O(t)}`, s, r);
+  return y(m({}, a), {
+    [t]: i
+  });
 }
 export {
-  l as useAsync,
-  h as useAsyncData,
-  l as useAsyncFunction
+  v as useAsync,
+  $ as useAsyncData,
+  v as useAsyncFunction
 };

package/dist/vue-asyncx.umd.cjs

@@ -1 +1 @@
-(function(t,f){typeof exports=="object"&&typeof module<"u"?f(exports,require("vue")):typeof define=="function"&&define.amd?define(["exports","vue"],f):(t=typeof globalThis<"u"?globalThis:t||self,f(t.VueAsyncx={},t.Vue))})(this,function(t,f){"use strict";function s(...e){if(!Array.isArray(e)||!e.length)throw TypeError("参数错误：未传递");const{name:o,fn:r,options:n}=typeof e[0]=="function"?{name:"method",fn:e[0],options:e[1]}:{name:e[0]||"method",fn:e[1],options:e[2]};if(typeof o!="string")throw TypeError("参数错误：name");if(typeof r!="function")throw TypeError("参数错误：fn");const i=f.ref(!1);function u(...y){i.value=!0;const c=r(...y);return c instanceof Promise?c.finally(()=>i.value=!1):i.value=!1,c}return n!=null&&n.watch?f.watch(n.watch,()=>u(),{immediate:n==null?void 0:n.immediate}):n!=null&&n.immediate&&u(),{[o]:u,[`${o}Loading`]:i}}function d(e){if(!e)return"";const o=e[0],r=e.slice(1);return o.toUpperCase()+r}function l(...e){if(!Array.isArray(e)||!e.length)throw TypeError("参数错误：未传递");const{name:o,fn:r,options:n}=typeof e[0]=="function"?{name:"data",fn:e[0],options:e[1]}:{name:e[0]||"data",fn:e[1],options:e[2]};if(typeof o!="string")throw TypeError("参数错误：name");if(typeof r!="function")throw TypeError("参数错误：fn");const i=f.ref();function u(...c){const a=r(...c);return a instanceof Promise?a.then(m=>i.value=m):i.value=a,a}return{...s(`query${d(o)}`,u,n),[o]:i}}t.useAsync=s,t.useAsyncData=l,t.useAsyncFunction=s,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})});
+(function(t,n){typeof exports=="object"&&typeof module!="undefined"?n(exports,require("vue")):typeof define=="function"&&define.amd?define(["exports","vue"],n):(t=typeof globalThis!="undefined"?globalThis:t||self,n(t.VueAsyncx={},t.Vue))})(this,function(t,n){"use strict";var T=Object.defineProperty,v=Object.defineProperties;var E=Object.getOwnPropertyDescriptors;var d=Object.getOwnPropertySymbols;var O=Object.prototype.hasOwnProperty,b=Object.prototype.propertyIsEnumerable;var m=(t,n,o)=>n in t?T(t,n,{enumerable:!0,configurable:!0,writable:!0,value:o}):t[n]=o,l=(t,n)=>{for(var o in n||(n={}))O.call(n,o)&&m(t,o,n[o]);if(d)for(var o of d(n))b.call(n,o)&&m(t,o,n[o]);return t},h=(t,n)=>v(t,E(n));function o(...e){var y;if(!Array.isArray(e)||!e.length)throw TypeError("参数错误：未传递");const{name:f,fn:u,options:s}=typeof e[0]=="function"?{name:"method",fn:e[0],options:e[1]}:{name:e[0]||"method",fn:e[1],options:e[2]};if(typeof f!="string")throw TypeError("参数错误：name");if(typeof u!="function")throw TypeError("参数错误：fn");const r=n.ref(!1);function a(...c){r.value=!0;const i=u(...c);return i instanceof Promise?i.finally(()=>r.value=!1):r.value=!1,i}if(s){const c=()=>{},i=Object.assign({},"immediate"in s?{immediate:s.immediate}:{},(y=s.watchOptions)!=null?y:{}),{watch:p}=s;n.watch(p!=null?p:c,()=>a(),i)}return{[f]:a,[`${f}Loading`]:r}}function A(e){if(!e)return"";const f=e[0],u=e.slice(1);return f.toUpperCase()+u}function w(...e){if(!Array.isArray(e)||!e.length)throw TypeError("参数错误：未传递");const{name:f,fn:u,options:s}=typeof e[0]=="function"?{name:"data",fn:e[0],options:e[1]}:{name:e[0]||"data",fn:e[1],options:e[2]};if(typeof f!="string")throw TypeError("参数错误：name");if(typeof u!="function")throw TypeError("参数错误：fn");const r=n.ref();function a(...c){const i=u(...c);return i instanceof Promise?i.then(p=>r.value=p):r.value=i,i}const y=o(`query${A(f)}`,a,s);return h(l({},y),{[f]:r})}t.useAsync=o,t.useAsyncData=w,t.useAsyncFunction=o,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-asyncx",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "",
   "type": "module",
   "types": "dist/vue-asyncx.d.ts",
@@ -15,7 +15,13 @@
       "require": "./dist/vue-asyncx.umd.cjs"
     }
   },
-  "keywords": [],
+  "keywords": [
+    "vue",
+    "utils",
+    "async",
+    "vueuse",
+    "hooks"
+  ],
   "author": "Xu Yiming",
   "license": "MIT",
   "repository": {
@@ -38,6 +44,6 @@
     "build": "vite build",
     "test:unit": "vitest",
     "test:unit:coverage": "vitest run --coverage",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "pnpm run test:unit"
   }
 }