vue3-request 1.0.18 → 1.0.20

package/README.md

@@ -1 +1,34 @@
-一个Vue3的异步请求处理库，旨在简化你的异步操作和api调用
+## ⚡ 快速安装
+
+```bash [pnpm]
+pnpm add vue3-request
+```
+
+## 🚀 5 分钟上手
+
+```vue
+<template>
+  <div>
+    <div v-if="loading">加载中...</div>
+    <div v-else-if="error">{{ error.message }}</div>
+    <div v-else>{{ data }}</div>
+    <button @click="refresh">刷新</button>
+    <button @click="abort">中止</button>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { useRequest } from "vue3-request";
+
+const getUserInfo = async () => {
+  const response = await fetch("/api/userInfo", {
+    signal: signal.value,
+  });
+  return response.json();
+};
+
+// 一行代码搞定状态管理
+const { data, error, loading, signal, refresh, abort } =
+  useRequest(getUserInfo); 
+</script>
+```

package/dist/vue3-request.cjs.js

@@ -1,509 +1 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const l = require("vue"),
-  C = (e) => e == null;
-function S(e) {
-  return C(e) ? e : typeof e == "number" && !isNaN(e);
-}
-function w(e, t) {
-  return S(e) === void 0
-    ? { is: !1, value: 0 }
-    : S(e)
-    ? t && e === -1
-      ? { is: !0, value: -1 }
-      : { is: !0, value: e === 0 || (e && e < 0) ? 0 : e }
-    : { is: !1, value: 0 };
-}
-const F = (e) => new Promise((t) => setTimeout(t, e)),
-  E = (e, t) => {
-    let s = t;
-    for (let n = e.length; n-- > 0; ) {
-      const r = e[n];
-      s = r(s);
-    }
-    return s?.();
-  },
-  P = () => new Promise(() => {});
-class q {
-  constructor(t, s) {
-    (this.service = t),
-      (this.options = s),
-      (this.currentRequestId = 0),
-      (this.pluginImpls = []),
-      (this.setState = (n) => {
-        Object.assign(this.state, n);
-      }),
-      (this.executePlugin = (n, ...r) => {
-        if (n === "onRequest")
-          return {
-            servicePromise: E(
-              this.pluginImpls.map((a) => a.onRequest).filter(Boolean),
-              r[0]
-            ),
-          };
-        {
-          const i = this.pluginImpls
-            .map((a) => a[n]?.apply(a, r))
-            .filter(Boolean);
-          return Object.assign({}, ...i);
-        }
-      }),
-      (this.loading = (n) => {
-        this.setState({ isLoading: n, isFinished: !n });
-      }),
-      (this.onFinished = () => {
-        this.executePlugin(
-          "onFinally",
-          this.state.params,
-          this.state.data,
-          this.state.error
-        ),
-          this.loading(!1),
-          this.options.onFinally?.(
-            this.state.params,
-            this.state.data,
-            this.state.error
-          );
-      }),
-      (this.runAsync = async (...n) => {
-        const r = ++this.currentRequestId,
-          {
-            signal: i,
-            isStaleTime: a,
-            isReady: o,
-          } = this.executePlugin("onBefore", this.state.params);
-        if (!o) return P();
-        if ((n.length && this.setState({ params: n }), this.loading(!0), a))
-          return this.loading(!1), this.state.data;
-        this.options.onBefore?.(this.state.params);
-        try {
-          const h = () => this.service(i)(...this.state.params);
-          let { servicePromise: f } = this.executePlugin("onRequest", h);
-          f || (f = h());
-          const u = await f;
-          return r !== this.currentRequestId
-            ? P()
-            : (this.setState({ data: u }),
-              this.executePlugin("onSuccess", u, this.state.params),
-              this.options.onSuccess?.(u, this.state.params),
-              this.onFinished(),
-              u);
-        } catch (h) {
-          if (r !== this.currentRequestId) return P();
-          const f = h;
-          throw (
-            (this.setState({ error: f }),
-            this.executePlugin("onError", f, this.state.params),
-            this.options.onError?.(f, this.state.params),
-            this.onFinished(),
-            f)
-          );
-        }
-      }),
-      (this.run = (...n) => {
-        this.runAsync(...n).catch((r) => {
-          this.options.onError;
-        });
-      }),
-      (this.refresh = () => {
-        this.run(...this.state.params);
-      }),
-      (this.refreshAsync = async () =>
-        await this.runAsync(...this.state.params)),
-      (this.cancel = () => {
-        (this.currentRequestId = 0),
-          this.loading(!1),
-          this.executePlugin("onCancel");
-      }),
-      (this.state = l.reactive({
-        data: void 0,
-        isLoading: !1,
-        isFinished: !1,
-        isAborted: !1,
-        error: void 0,
-        params: s?.defaultParams || [],
-      }));
-  }
-}
-const R = new Map(),
-  x = (e, { data: t, params: s, time: n }) => {
-    R.set(e, { data: t, params: s, time: n });
-  },
-  y = (e) => R.get(e),
-  A = (e) => {
-    e ? R.delete(e) : R.clear();
-  };
-function O(e, t, s) {
-  const n = { manual: !1, defaultParams: [], ...t },
-    r = new q(e, n);
-  (r.pluginImpls = s.map((c) => c(r, n))),
-    n.manual || r.run(...n.defaultParams),
-    l.onUnmounted(r.cancel);
-  const {
-    run: i,
-    cancel: a,
-    refresh: o,
-    runAsync: h,
-    refreshAsync: f,
-    abort: u,
-  } = r;
-  return {
-    ...l.toRefs(r.state),
-    run: i,
-    cancel: a,
-    refresh: o,
-    runAsync: h,
-    abort: u,
-    refreshAsync: f,
-    clearCache: A,
-  };
-}
-const B = (e) => {
-    let t = null,
-      { setState: s } = e;
-    const n = () => (
-      (t = new AbortController()),
-      s({ isAborted: t.signal.aborted }),
-      { signal: t.signal }
-    );
-    return (
-      (e.abort = () => {
-        t &&
-          !t.signal.aborted &&
-          !e.state.isFinished &&
-          (t.abort(), s({ isAborted: t.signal.aborted }));
-      }),
-      {
-        onBefore: () => {
-          e.abort();
-          const { signal: r } = n();
-          return { signal: r };
-        },
-        onRequest: (r) => r,
-        onCancel: () => {
-          e.abort(), (t = null);
-        },
-      }
-    );
-  },
-  v = new Map(),
-  I = (e, { data: t, params: s, time: n }) => {
-    v.has(e) && v.get(e)?.forEach((i) => i({ data: t, params: s, time: n }));
-  },
-  T = (e, t) => (
-    v.has(e) ? v.get(e)?.add(t) : v.set(e, new Set()),
-    () => {
-      const s = v.get(e);
-      s?.delete(t), s?.size === 0 && v.delete(e);
-    }
-  ),
-  b = new Map(),
-  L = (e, t) => {
-    b.set(e, t),
-      t
-        .then(() => {})
-        .catch(() => {})
-        .finally(() => {
-          W(e);
-        });
-  },
-  M = (e) => b.get(e),
-  W = (e) => {
-    e ? b.delete(e) : b.clear();
-  },
-  j = (
-    e,
-    { cacheKey: t, cacheTime: s = new Date(0).setMinutes(5), staleTime: n = 0 }
-  ) => {
-    const { setState: r } = e,
-      i = l.ref(null);
-    let a = null;
-    const o = (u) => {
-      t &&
-        (a && (window.clearTimeout(a), (a = null)),
-        (a = window.setTimeout(() => {
-          A(t), (a = null);
-        }, u)));
-    };
-    function h() {
-      if (!t) return;
-      const u = y(t);
-      u && r({ data: u.data, params: u.params }),
-        (i.value = T(t, (c) => {
-          r({ data: c.data, params: c.params });
-        }));
-    }
-    h();
-    const f = () => {
-      if (!t) return null;
-      const u = y(t);
-      return !u || Date.now() - u.time > n ? null : !0;
-    };
-    return {
-      onBefore: () => (f() ? { isStaleTime: !0 } : { isStaleTime: !1 }),
-      onRequest: (u) => {
-        if (!t) return u;
-        let c = M(t);
-        return c ? () => c : ((c = u()), L(t, c), () => c);
-      },
-      onSuccess: (u, c) => {
-        if (!t) return;
-        const d = { data: u, params: c, time: Date.now() };
-        i.value?.(),
-          (i.value = T(t, (m) => {
-            r({ data: m.data, params: m.params });
-          })),
-          x(t, d),
-          I(t, d),
-          o(s);
-      },
-      onCancel: () => {
-        i.value?.();
-      },
-    };
-  },
-  D = (e, { errorRetryCount: t = 0, errorRetryInterval: s }) => {
-    const n = l.ref(0),
-      r = l.ref(!0),
-      { refresh: i } = e,
-      a = l.computed(() => 1e3 * Math.pow(2, n.value)),
-      o = () => {
-        (n.value = 0), (r.value = !1);
-      },
-      h = async () => {
-        let { is: u, value: c } = w(l.toValue(s));
-        u || (c = l.toValue(a)), await F(c), i();
-      },
-      f = async () => {
-        const { is: u, value: c } = w(l.toValue(t), !0);
-        u && (n.value++, c === -1 || n.value <= c ? await h() : (n.value = 0));
-      };
-    return {
-      onError: () => {
-        r.value ? f() : (r.value = !0);
-      },
-      onCancel: () => {
-        o();
-      },
-    };
-  },
-  N = (e, { pollingInterval: t }) => {
-    const { refresh: s } = e;
-    let n = null;
-    const r = () => {
-        const { is: a, value: o } = w(l.toValue(t));
-        a && (i(), (n = window.setInterval(s, o)));
-      },
-      i = () => {
-        n && window.clearInterval(n), (n = null);
-      };
-    return {
-      onBefore: () => {
-        r();
-      },
-      onCancel: () => {
-        i();
-      },
-    };
-  },
-  V = (e, { refreshDeps: t = [], refreshDepsAction: s }) => {
-    const { refresh: n } = e,
-      r = l.watch(
-        t,
-        () => {
-          if (s) return s();
-          n();
-        },
-        { deep: !0 }
-      );
-    return {
-      onCancel: () => {
-        r();
-      },
-    };
-  },
-  z = (e, { refocusTimespan: t = 5e3, refreshOnWindowFocus: s }) => {
-    const { refresh: n } = e,
-      r = l.ref(!0);
-    function i() {
-      s &&
-        (window.addEventListener("focus", a),
-        window.document.addEventListener("visibilitychange", a));
-    }
-    i();
-    async function a() {
-      const { is: o, value: h } = w(t);
-      o &&
-        window.document.visibilityState === "visible" &&
-        navigator.onLine &&
-        r.value &&
-        (n(), (r.value = !1), await F(h), (r.value = !0));
-    }
-    return {
-      onCancel: () => {
-        window.removeEventListener("focus", a),
-          window.document.removeEventListener("visibilitychange", a);
-      },
-    };
-  },
-  U = (e, { manual: t, ready: s = l.ref(!0) }) => {
-    const n = l.computed(() => l.toValue(s)),
-      r = l.watch(n, (i) => {
-        !t && i && e.refresh();
-      });
-    return {
-      onBefore: () => {
-        if (n.value) return { isReady: !0 };
-      },
-      onCancel: () => {
-        r();
-      },
-    };
-  };
-function G(e, t, s) {
-  var n = null,
-    r = null,
-    i =
-      typeof s == "boolean"
-        ? { leading: s, trailing: !s }
-        : Object.assign({ leading: !1, trailing: !0 }, s),
-    a = !1,
-    o = null,
-    h = i.leading,
-    f = i.trailing,
-    u = function () {
-      (n = null), (r = null);
-    },
-    c = function () {
-      (a = !0), e.apply(r, n), u();
-    },
-    d = function () {
-      if ((h === !0 && (o = null), a)) {
-        u();
-        return;
-      }
-      if (f === !0) {
-        c();
-        return;
-      }
-      u();
-    },
-    m = function () {
-      var p = o !== null;
-      return p && clearTimeout(o), u(), (o = null), (a = !1), p;
-    },
-    g = function () {
-      (a = !1),
-        (n = arguments),
-        (r = this),
-        o === null ? h === !0 && c() : clearTimeout(o),
-        (o = setTimeout(d, t));
-    };
-  return (g.cancel = m), g;
-}
-const H = (e, { debounceWait: t, debounceOptions: s, manual: n }) => {
-  let r = n,
-    i = null;
-  const a = l.computed(() => l.toValue(t)),
-    o = l.computed(() => l.toValue(s)),
-    h = e.runAsync;
-  return (
-    r || (r = !0),
-    l.watchEffect(() => {
-      C(a.value) ||
-        ((i = G((f) => f(), a.value, o.value)),
-        (e.runAsync = (...f) =>
-          new Promise((u, c) => {
-            r
-              ? ((r = !1),
-                h(...f)
-                  .then(u)
-                  .catch(c))
-              : i(() => {
-                  h(...f)
-                    .then(u)
-                    .catch(c);
-                });
-          })),
-        l.onWatcherCleanup(() => {
-          i?.cancel(), (e.runAsync = h);
-        }));
-    }),
-    {
-      onCancel: () => {
-        i?.cancel(), (i = null), (r = !1);
-      },
-    }
-  );
-};
-function J(e, t, s) {
-  var n = null,
-    r = null,
-    i = !1,
-    a = null,
-    o = Object.assign({ leading: !0, trailing: !0 }, s),
-    h = o.leading,
-    f = o.trailing,
-    u = function () {
-      (n = null), (r = null);
-    },
-    c = function () {
-      (i = !0), e.apply(r, n), (a = setTimeout(d, t)), u();
-    },
-    d = function () {
-      if (((a = null), i)) {
-        u();
-        return;
-      }
-      if (f === !0) {
-        c();
-        return;
-      }
-      u();
-    },
-    m = function () {
-      var p = a !== null;
-      return p && clearTimeout(a), u(), (a = null), (i = !1), p;
-    },
-    g = function () {
-      if (((n = arguments), (r = this), (i = !1), a === null && h === !0)) {
-        c();
-        return;
-      }
-      f === !0 && (a = setTimeout(d, t));
-    };
-  return (g.cancel = m), g;
-}
-const Q = (e, { throttleWait: t, throttleOptions: s }) => {
-    let n = null;
-    const r = l.computed(() => l.toValue(t)),
-      i = l.computed(() => l.toValue(s)),
-      a = e.runAsync;
-    return (
-      l.watchEffect(() => {
-        C(r.value) ||
-          ((n = J((o) => o(), r.value, i.value)),
-          (e.runAsync = (...o) =>
-            new Promise((h, f) => {
-              n(() => {
-                a(...o)
-                  .then(h)
-                  .catch(f);
-              });
-            })),
-          l.onWatcherCleanup(() => {
-            n?.cancel(), (e.runAsync = a);
-          }));
-      }),
-      {
-        onCancel: () => {
-          n?.cancel(), (n = null);
-        },
-      }
-    );
-  },
-  X = [D, N, V, z, B, U, H, Q, j];
-function Y(e, t, s) {
-  return O(e, t, [...(s || []), ...X]);
-}
-exports.useRequest = Y;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("vue"),b=e=>e,V=e=>e==null;function A(e){return V(e)?e:typeof e=="number"&&!isNaN(e)}function w(e,t){return A(e)===void 0?{is:!1,value:0}:A(e)?t&&e===-1?{is:!0,value:-1}:{is:!0,value:e===0||e&&e<0?0:e}:{is:!1,value:0}}const M=(e,t)=>{let n=t;for(let s=e.length;s-- >0;){const r=e[s];n=r(n)}return n?.()},C=()=>new Promise(()=>{}),O=e=>e instanceof Function,R=new Map,L=(e,t,{data:n,params:s,time:r})=>{let u;const a=x(e),{is:o,value:l}=w(t,!0);o&&(a?.timer&&window.clearTimeout(a?.timer),l!==-1&&(u=window.setTimeout(()=>{T(e)},l)),R.set(e,{data:n,params:s,time:r,timer:u}))},x=e=>R.get(e),T=e=>{e&&typeof e=="string"?R.delete(e):R.clear()};class j{constructor(t,n){this.service=t,this.options=n,this.state=i.reactive({data:void 0,error:void 0,params:n?.defaultParams||[],loading:!1,isFinished:!1,isAborted:!1,signal:new AbortController().signal})}currentRequestId=0;pluginImpls=[];state;abort=()=>{};setState=t=>{Object.assign(this.state,t)};executePlugin=(t,...n)=>{if(t==="onRequest")return{servicePromise:M(this.pluginImpls.map(r=>r.onRequest).filter(Boolean),n[0])};{const s=this.pluginImpls.map(r=>r[t]?.(...n)).filter(Boolean);return Object.assign({},...s)}};loading=t=>{this.setState({loading:t,isFinished:!t})};onFinished=()=>{this.executePlugin("onFinally",this.state.params,this.state.data,this.state.error),this.loading(!1),this.options.onFinally?.(this.state.params,this.state.data,this.state.error)};runAsync=async(...t)=>{const n=++this.currentRequestId,{isReturn:s,isReady:r,...u}=this.executePlugin("onBefore",t);if(!r)return C();if(this.setState({params:t}),this.loading(!0),s)return this.loading(u.loading||!1),u.data;this.options.onBefore?.(t);try{const a=()=>this.service(...t);let{servicePromise:o}=this.executePlugin("onRequest",a);o||(o=a());const l=await o;return n!==this.currentRequestId?C():(this.setState({data:l,error:void 0}),this.executePlugin("onSuccess",l,t),this.options.onSuccess?.(l,t),this.onFinished(),l)}catch(a){if(n!==this.currentRequestId)return C();const o=a;throw this.setState({data:void 0,error:o}),this.executePlugin("onError",o,t),this.options.onError?.(o,t),this.onFinished(),o}};run=(...t)=>{this.runAsync(...t).catch(n=>{this.options.onError})};refresh=()=>{this.run(...this.state.params)};refreshAsync=async()=>await this.runAsync(...this.state.params);mutate=t=>{O(t)?t(this.state.data):this.setState({data:t}),this.executePlugin("onMutate",this.state.data)};cancel=()=>{this.executePlugin("onCancel"),this.currentRequestId++,this.loading(!1)}}function N(e,t,n){const s={manual:!1,...t},r=new j(e,s);r.pluginImpls=n.map(g=>g(r,s)),i.onMounted(()=>{if(!s.manual){const g=r.state.params;r.run(...g)}}),i.onUnmounted(r.cancel);const{run:u,cancel:a,refresh:o,runAsync:l,refreshAsync:v,abort:f,mutate:h}=r;return{...i.toRefs(r.state),run:u,cancel:a,refresh:o,runAsync:l,mutate:h,abort:f,refreshAsync:v,clearCache:T}}const U=b((e,{abortPrevious:t=!0})=>{let n=null;const s=()=>{n=new AbortController,e.setState({signal:n.signal,isAborted:n.signal.aborted})};return e.abort=()=>{n&&!n.signal.aborted&&!e.state.isFinished&&(n.abort(),e.setState({isAborted:n.signal.aborted}))},{onBefore:()=>{typeof t=="boolean"&&t&&e.abort(),s()},onRequest:r=>()=>r(),onCancel:()=>{e.abort(),n=null}}}),p=new Map,D=(e,{data:t,params:n,time:s})=>{p.has(e)&&p.get(e)?.forEach(u=>u({data:t,params:n,time:s}))},E=(e,t)=>(p.has(e)?p.get(e)?.add(t):p.set(e,new Set),()=>{const n=p.get(e);n?.delete(t),n?.size===0&&p.delete(e)}),P=new Map,W=(e,t)=>{P.set(e,t),t.then(n=>{}).catch(()=>{}).finally(()=>{_(e)})},H=e=>P.get(e),_=e=>{e&&typeof e=="string"?P.delete(e):P.clear()},$=b((e,{cacheKey:t,cacheTime:n=3e5,staleTime:s=0,setCache:r,getCache:u})=>{const a=i.ref(null);let o=null;const{is:l,value:v}=w(s,!0);if(!l)return{};const f=(c,d)=>{r?r(c,d):L(c,n,d),D(c,d)},h=c=>u?u(c):x(c);function g(){if(!t)return;const c=h(t);c&&Reflect.has(c,"data")&&e.setState({data:c.data,params:c.params}),a.value=E(t,d=>{e.setState({data:d.data})})}return g(),i.onUnmounted(()=>{a.value?.()}),{onBefore:()=>{if(!t)return null;const c=h(t);return!c||!Reflect.has(c,"data")?{}:v===-1||Date.now()-c.time<v?{loading:!1,data:c.data,error:void 0,isReturn:!0}:{data:c.data,error:void 0}},onRequest:c=>{if(!t)return c;let d=H(t);return d&&d!==o?()=>d:(d=c(),o=d,W(t,d),()=>d)},onSuccess:(c,d)=>{if(!t)return;const m={data:c,params:d,time:Date.now()};a.value?.(),f(t,m),a.value=E(t,B=>{e.setState({data:B.data})})}}}),z=b((e,{errorRetryCount:t=0,errorRetryInterval:n})=>{const s=i.ref(),r=i.ref(0),u=i.ref(!1),a=i.computed(()=>1e3*Math.pow(2,r.value)),o=()=>{let f=null;r.value++;const{value:h}=w(i.toValue(t),!0),g=h===-1,c=r.value<=h;if(g||c){let{is:d,value:m}=w(i.toValue(n));d||(m=i.toValue(Math.min(a.value,3e4))),f=window.setTimeout(()=>{u.value=!0,e.refresh()},m)}return()=>{f&&window.clearTimeout(f)}},l=()=>{s.value?.()},{is:v}=w(i.toValue(t),!0);return v?{onBefore:()=>{u.value||(r.value=0),u.value=!1,l()},onSuccess:()=>{r.value=0},onError:()=>{s.value=o()},onCancel:()=>{r.value=0,l()}}:{}}),y=()=>document.visibilityState==="visible",F=new Set,I=e=>(F.add(e),()=>{F.delete(e)}),J=()=>{y()&&F.forEach(e=>{e()})};window.addEventListener("visibilitychange",J,!1);const Q=b((e,{pollingInterval:t,pollingWhenHidden:n=!0,errorRetryCount:s})=>{const r=i.ref(null),u=i.ref(),a=()=>{let o;const{value:l}=w(i.toValue(s),!0);if(e.state.error&&l!==0)return;const{is:v,value:f}=w(i.toValue(t));if(!v)return;const h=f;return o=window.setTimeout(()=>{!i.toValue(n)&&!y()?r.value=I(e.refresh):e.refresh()},h),()=>{o&&window.clearTimeout(o),r.value?.()}};return i.watch([()=>i.toValue(t),()=>i.toValue(n)],()=>{u.value?.(),u.value=a()}),i.onUnmounted(()=>{r.value?.()}),{onBefore:()=>{u.value?.()},onCancel:()=>{u.value?.()},onFinally:()=>{u.value=a()}}}),X=b((e,{manual:t,refreshDeps:n,refreshDepsAction:s})=>{if(V(n)||typeof n!="object"&&typeof n!="function")return{};const r=i.watch(n,()=>{t||(s?s():e.refresh())},{deep:!0});return{onCancel:()=>{r()}}}),Y=()=>window.navigator.onLine,S=new Set,Z=e=>(S.add(e),()=>{S.delete(e)}),q=()=>{!y()||!Y()||S.forEach(e=>{e()})};window.addEventListener("visibilitychange",q,!1);window.addEventListener("focus",q,!1);const G=b((e,{refocusTimespan:t=5e3,refreshOnWindowFocus:n=!1})=>{const s=i.ref(),{is:r}=w(i.toValue(t));if(!r||V(i.toValue(n))||typeof i.toValue(n)!="boolean")return{};const u=(a,o)=>{let l=!1;return()=>{l||(l=!0,a(),window.setTimeout(()=>{l=!1},o))}};return i.watchEffect(()=>{s.value?.(),i.toValue(n)&&(s.value=Z(u(e.refresh,i.toValue(t))))}),i.onUnmounted(()=>{s.value?.()}),{}}),k=b((e,{manual:t,ready:n=!0,defaultParams:s=[]})=>{const r=i.watch(()=>i.toValue(n),u=>{!t&&u&&e.run(...s)},{flush:"sync"});return{onBefore:()=>({isReady:i.toValue(n)}),onCancel:()=>{r()}}});function K(e,t,n){var s=null,r=null,u=typeof n=="boolean"?{leading:n,trailing:!n}:Object.assign({leading:!1,trailing:!0},n),a=!1,o=null,l=u.leading,v=u.trailing,f=function(){s=null,r=null},h=function(){a=!0,e.apply(r,s),f()},g=function(){if(l===!0&&(o=null),a){f();return}if(v===!0){h();return}f()},c=function(){var m=o!==null;return m&&clearTimeout(o),f(),o=null,a=!1,m},d=function(){a=!1,s=arguments,r=this,o===null?l===!0&&h():clearTimeout(o),o=setTimeout(g,t)};return d.cancel=c,d}const ee=b((e,{debounceWait:t,debounceOptions:n,manual:s})=>{const r=i.ref(!1);let u=null;const a=e.runAsync;return s||(r.value=!0),i.watchEffect(()=>{const{is:o,value:l}=w(i.toValue(t));if(!o)return;const v=i.toValue(n);u=K(f=>f(),l,v),e.runAsync=(...f)=>new Promise((h,g)=>{r.value?(r.value=!1,a(...f).then(h).catch(g)):u(()=>{a(...f).then(h).catch(g)})}),i.onWatcherCleanup(()=>{u?.cancel(),e.runAsync=a})}),{onCancel:()=>{u?.cancel()}}});function te(e,t,n){var s=null,r=null,u=!1,a=null,o=Object.assign({leading:!0,trailing:!0},n),l=o.leading,v=o.trailing,f=function(){s=null,r=null},h=function(){u=!0,e.apply(r,s),a=setTimeout(g,t),f()},g=function(){if(a=null,u){f();return}if(v===!0){h();return}f()},c=function(){var m=a!==null;return m&&clearTimeout(a),f(),a=null,u=!1,m},d=function(){if(s=arguments,r=this,u=!1,a===null&&l===!0){h();return}v===!0&&(a=setTimeout(g,t))};return d.cancel=c,d}const ne=b((e,{throttleWait:t,throttleOptions:n})=>{let s=null;const r=e.runAsync;return i.watchEffect(()=>{const{is:u,value:a}=w(i.toValue(t));if(!u)return;const o=i.toValue(n);s=te(l=>l(),a,o),e.runAsync=(...l)=>new Promise((v,f)=>{s(()=>{r(...l).then(v).catch(f)})}),i.onWatcherCleanup(()=>{s?.cancel(),e.runAsync=r})}),{onCancel:()=>{s?.cancel()}}}),re=[z,Q,X,G,U,k,ee,ne,$];function se(e,t,n){return N(e,t||{},[...n||[],...re])}exports.clearCache=T;exports.definePlugin=b;exports.useRequest=se;

package/dist/vue3-request.es.d.ts

@@ -1,55 +1,73 @@
 import { Reactive } from 'vue';
 import { Ref } from 'vue';
 import { ToRefs } from 'vue';
+import { WatchSource } from 'vue';
 
-declare type CallbackType<D = any, P extends any[] = any> = (signal?: AbortSignal) => ServiceType<D, P>;
-
-declare type DebounceOptionsType = {
-    leading?: boolean;
-    trailing?: boolean;
-};
-
-declare type IOptions<D, P extends any[]> = Partial<{
+declare type BaseOptions<D, P extends any[]> = Partial<{
     onBefore: (params: P) => void;
     onSuccess: (data: D, params: P) => void;
-    onFinally: (params: P, data: D, error: Error) => void;
+    onFinally: (params: P, data?: D, error?: Error) => void;
     onError: (error: Error, params: P) => void;
     manual: boolean;
     defaultParams: P;
-    refreshDeps: (Ref<any> | Reactive<any>)[];
+    refreshDeps: WatchSource | WatchSource[] | object;
     refreshDepsAction: () => void;
     pollingInterval: number | Ref<number>;
+    pollingWhenHidden: boolean | Ref<boolean>;
     errorRetryCount: number | Ref<number>;
     errorRetryInterval: number | Ref<number>;
-    refreshOnWindowFocus: boolean;
-    refocusTimespan: number;
+    refreshOnWindowFocus: boolean | Ref<boolean>;
+    refocusTimespan: number | Ref<number>;
     cacheKey: string;
     cacheTime: number;
     staleTime: number;
+    setCache: (cacheKey: string, cacheData: CacheParamsType) => void;
+    getCache: (cacheKey: string) => CacheParamsType;
     ready: Ref<boolean> | (() => boolean);
     debounceWait: Ref<number> | number;
     debounceOptions: Reactive<DebounceOptionsType> | DebounceOptionsType;
     throttleWait: Ref<number> | number;
     throttleOptions: Reactive<ThrottleOptionsType> | ThrottleOptionsType;
+    abortPrevious: boolean;
 }>;
 
+declare type CacheParamsType<D = any, P = any> = {
+    data?: D;
+    params: P;
+    time: number;
+} & {
+    timer?: number;
+};
+
+export declare const clearCache: (cacheKey?: string) => void;
+
+declare type DebounceOptionsType = {
+    leading?: boolean;
+    trailing?: boolean;
+};
+
+export declare const definePlugin: <D = any, P extends any[] = any, O = {}>(plugin: Plugin_2<D, P, O>) => Plugin_2<D, P, O>;
+
 declare interface IState<D, P extends any[]> {
-    data: D | undefined;
-    isLoading: boolean;
+    data?: D;
+    loading: boolean;
     isFinished: boolean;
     isAborted: boolean;
-    error: Error | undefined;
+    error?: Error;
     params: P;
+    signal: AbortSignal;
 }
 
-declare type Plugin_2<D = any, P extends any[] = any> = (requestInstance: Request_2<D, P>, options: IOptions<D, P>) => PluginReturn<D, P>;
+declare type Plugin_2<D = any, P extends any[] = any, O = {}> = (requestInstance: Request_2<D, P>, options: BaseOptions<D, P> & O) => PluginReturn<D, P>;
 export { Plugin_2 as Plugin }
 
 declare type PluginMethodsReturn<D, P extends any[]> = Partial<{
-    servicePromise?: ReturnType<ServiceType<D, P>>;
-    signal?: AbortSignal;
-    isStaleTime?: boolean;
-    isReady?: boolean;
+    servicePromise: ReturnType<ServiceType<D, P>>;
+    signal: AbortSignal;
+    isReturn: boolean;
+    isReady: boolean;
+    data?: D;
+    loading: boolean;
 }>;
 
 declare type PluginReturn<D, P extends any[]> = Partial<{
@@ -58,25 +76,27 @@ declare type PluginReturn<D, P extends any[]> = Partial<{
     onFinally: (params: P, data: D, error: Error) => void;
     onError: (error: Error, params: P) => void;
     onCancel: () => void;
+    onMutate: (data: D | ((data: D) => D)) => void;
     onRequest: (service: ServiceType<D, P>) => ServiceType<D, P>;
 }>;
 
 declare class Request_2<D, P extends any[]> {
-    service: CallbackType<D, P>;
-    options?: IOptions<D, P>;
+    service: ServiceType<D, P>;
+    options: BaseOptions<D, P>;
     currentRequestId: number;
     pluginImpls: PluginReturn<D, P>[];
     state: IState<D, P>;
     abort: () => void;
-    constructor(service: CallbackType<D, P>, options?: IOptions<D, P>);
+    constructor(service: ServiceType<D, P>, options: BaseOptions<D, P>);
     setState: (s: Partial<IState<D, P>>) => void;
     executePlugin: (event: keyof PluginReturn<D, P>, ...rest: any[]) => PluginMethodsReturn<D, P>;
-    loading: (isLoading: boolean) => void;
+    loading: (loading: boolean) => void;
     onFinished: () => void;
     runAsync: (...params: P) => Promise<D>;
     run: (...params: P) => void;
     refresh: () => void;
     refreshAsync: () => Promise<D>;
+    mutate: (data: D | ((data: D) => D)) => void;
     cancel: () => void;
 }
 
@@ -87,7 +107,9 @@ declare type ThrottleOptionsType = {
     trailing?: boolean;
 };
 
-export declare function useRequest<D, P extends any[]>(service: CallbackType<D, P>, options?: IOptions<D, P>, plugins?: Plugin_2<D, P>[]): UseRequestReturnType<D, P>;
+export declare function useRequest<D, P extends any[] = any[]>(service: ServiceType<D, P>, options?: BaseOptions<D, P>): UseRequestReturnType<D, P>;
+
+export declare function useRequest<D, P extends any[] = any[], O = {}>(service: ServiceType<D, P>, options: BaseOptions<D, P> & O, plugins: Plugin_2<D, P, O>[]): UseRequestReturnType<D, P>;
 
 declare interface UseRequestReturnType<D, P extends any[]> extends ToRefs<IState<D, P>> {
     run: (...args: P) => void;
@@ -96,7 +118,8 @@ declare interface UseRequestReturnType<D, P extends any[]> extends ToRefs<IState
     runAsync: (...args: P) => Promise<D>;
     abort: () => void;
     refreshAsync: () => Promise<D>;
-    clearCache: () => void;
+    clearCache: (key?: string) => void;
+    mutate: (data: D | ((data: D) => D)) => void;
 }
 
 export { }