@vueuse/integrations - npm Package Compare versions

Comparing version 4.2.1 to 4.2.2

dist/index.cjs.js

@@ -24,7 +24,24 @@ 'use strict';
  *
- * @see   {@link https://vueuse.js.org/useAxios}
+ * @see   {@link https://vueuse.org/useAxios}
  * @param url
  * @param config
  */
-function useAxios(url, config) {
+function useAxios(url, ...args) {
+    let config = {};
+    let instance = axios__default['default'];
+    if (args.length > 0) {
+        /**
+         * Unable to use `instanceof` here becuase of (https://github.com/axios/axios/issues/737)
+         * so instead we are checking if there is a `requset` on the object to see if it is an
+         * axios instance
+         */
+        if ('request' in args[0])
+            instance = args[0];
+        else
+            config = args[0];
+    }
+    if (args.length > 1) {
+        if ('request' in args[1])
+            instance = args[1];
+    }
     const response = vueDemi.ref(null);
@@ -40,3 +57,3 @@ const data = vueDemi.ref(undefined);
     };
-    axios__default['default'](url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
+    instance(url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
         .then((r) => {
@@ -139,3 +156,3 @@ response.value = r;
  *
- * @see {@link https://vueuse.js.org/useJwt}
+ * @see {@link https://vueuse.org/useJwt}
  * @param jwt
@@ -166,3 +183,3 @@ */
  *
- * @see   {@link https://vueuse.js.org/useNProgress}
+ * @see   {@link https://vueuse.org/useNProgress}
  * @param currentProgress
@@ -206,3 +223,3 @@ * @param options
  *
- * @see   {@link https://vueuse.js.org/useQRCode}
+ * @see   {@link https://vueuse.org/useQRCode}
  * @param text
@@ -209,0 +226,0 @@ * @param options

dist/index.d.ts

 import { Ref, ComputedRef, WritableComputedRef } from 'vue-demi';
-import { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
+import { AxiosRequestConfig, AxiosInstance, AxiosResponse, AxiosError } from 'axios';
 import universal_cookie, { CookieGetOptions, CookieSetOptions, CookieChangeListener } from 'universal-cookie';
@@ -10,17 +10,12 @@ import { IncomingMessage } from 'http';
 
-/**
- * Wrapper for axios.
- *
- * @see   {@link https://vueuse.js.org/useAxios}
- * @param url
- * @param config
- */
-declare function useAxios<T = any>(url: string, config?: AxiosRequestConfig): {
+interface UseAxiosReturn<T> {
     response: Ref<AxiosResponse<T> | undefined>;
     data: Ref<T | undefined>;
-    error: Ref<AxiosError<T> | undefined>;
     finished: Ref<boolean>;
-    cancel: (message?: string | undefined) => void;
     canceled: Ref<boolean>;
-};
+    error: Ref<AxiosError<T> | undefined>;
+}
+declare function useAxios<T = any>(url: string, config?: AxiosRequestConfig): UseAxiosReturn<T>;
+declare function useAxios<T = any>(url: string, instance?: AxiosInstance): UseAxiosReturn<T>;
+declare function useAxios<T = any>(url: string, config: AxiosRequestConfig, instance: AxiosInstance): UseAxiosReturn<T>;
 
@@ -95,3 +90,3 @@ /**
  *
- * @see {@link https://vueuse.js.org/useJwt}
+ * @see {@link https://vueuse.org/useJwt}
  * @param jwt
@@ -104,3 +99,3 @@ */
  *
- * @see   {@link https://vueuse.js.org/useNProgress}
+ * @see   {@link https://vueuse.org/useNProgress}
  * @param currentProgress
@@ -120,3 +115,3 @@ * @param options
  *
- * @see   {@link https://vueuse.js.org/useQRCode}
+ * @see   {@link https://vueuse.org/useQRCode}
  * @param text
@@ -123,0 +118,0 @@ * @param options

dist/index.esm.js

@@ -12,7 +12,24 @@ import { ref, computed, isRef, watchEffect, watch } from 'vue-demi';
  *
- * @see   {@link https://vueuse.js.org/useAxios}
+ * @see   {@link https://vueuse.org/useAxios}
  * @param url
  * @param config
  */
-function useAxios(url, config) {
+function useAxios(url, ...args) {
+    let config = {};
+    let instance = axios;
+    if (args.length > 0) {
+        /**
+         * Unable to use `instanceof` here becuase of (https://github.com/axios/axios/issues/737)
+         * so instead we are checking if there is a `requset` on the object to see if it is an
+         * axios instance
+         */
+        if ('request' in args[0])
+            instance = args[0];
+        else
+            config = args[0];
+    }
+    if (args.length > 1) {
+        if ('request' in args[1])
+            instance = args[1];
+    }
     const response = ref(null);
@@ -28,3 +45,3 @@ const data = ref(undefined);
     };
-    axios(url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
+    instance(url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
         .then((r) => {
@@ -127,3 +144,3 @@ response.value = r;
  *
- * @see {@link https://vueuse.js.org/useJwt}
+ * @see {@link https://vueuse.org/useJwt}
  * @param jwt
@@ -154,3 +171,3 @@ */
  *
- * @see   {@link https://vueuse.js.org/useNProgress}
+ * @see   {@link https://vueuse.org/useNProgress}
  * @param currentProgress
@@ -194,3 +211,3 @@ * @param options
  *
- * @see   {@link https://vueuse.js.org/useQRCode}
+ * @see   {@link https://vueuse.org/useQRCode}
  * @param text
@@ -197,0 +214,0 @@ * @param options

dist/index.iife.js

@@ -58,7 +58,24 @@ ;(function (window) {
    *
-   * @see   {@link https://vueuse.js.org/useAxios}
+   * @see   {@link https://vueuse.org/useAxios}
    * @param url
    * @param config
    */
-  function useAxios(url, config) {
+  function useAxios(url, ...args) {
+      let config = {};
+      let instance = axios__default['default'];
+      if (args.length > 0) {
+          /**
+           * Unable to use `instanceof` here becuase of (https://github.com/axios/axios/issues/737)
+           * so instead we are checking if there is a `requset` on the object to see if it is an
+           * axios instance
+           */
+          if ('request' in args[0])
+              instance = args[0];
+          else
+              config = args[0];
+      }
+      if (args.length > 1) {
+          if ('request' in args[1])
+              instance = args[1];
+      }
       const response = vueDemi.ref(null);
@@ -74,3 +91,3 @@ const data = vueDemi.ref(undefined);
       };
-      axios__default['default'](url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
+      instance(url, Object.assign(Object.assign({}, config), { cancelToken: cancelToken.token }))
           .then((r) => {
@@ -173,3 +190,3 @@ response.value = r;
    *
-   * @see {@link https://vueuse.js.org/useJwt}
+   * @see {@link https://vueuse.org/useJwt}
    * @param jwt
@@ -200,3 +217,3 @@ */
    *
-   * @see   {@link https://vueuse.js.org/useNProgress}
+   * @see   {@link https://vueuse.org/useNProgress}
    * @param currentProgress
@@ -240,3 +257,3 @@ * @param options
    *
-   * @see   {@link https://vueuse.js.org/useQRCode}
+   * @see   {@link https://vueuse.org/useQRCode}
    * @param text
@@ -243,0 +260,0 @@ * @param options

dist/index.iife.min.js

@@ -1,1 +0,1 @@
-!function(e){if(!e.VueDemi){var t={},n=e.Vue;if(n)if("2."===n.version.slice(0,2)){var o=e.VueCompositionAPI;if(o){for(var u in o)t[u]=o[u];t.isVue2=!0,t.isVue3=!1,t.install=function(){},t.Vue=n,t.version=n.version}else console.error("[vue-demi] no VueCompositionAPI instance found, please be sure to import `@vue/composition-api` before `vue-demi`.")}else if("3."===n.version.slice(0,2)){for(var u in n)t[u]=n[u];t.isVue2=!1,t.isVue3=!0,t.install=function(){},t.Vue=n,t.version=n.version}else console.error("[vue-demi] Vue version "+n.version+" is unsupported.");else console.error("[vue-demi] no Vue instance found, please be sure to import `vue` before `vue-demi`.");e.VueDemi=t}}(window),function(e,t,n,o,u,r,a,s){"use strict";function i(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var l=i(n),d=i(u),c=i(r),f=i(a),v=i(s);function m(e,{doNotParse:n=!1,autoUpdateDependencies:u=!1}={},r=new d.default){const a=u?[...e||[]]:e;let s=r.getAll({doNotParse:!0});const i=t.ref(0),l=()=>{const e=r.getAll({doNotParse:!0});(function(e,t,n){if(!e)return!0;for(const o of e)if(t[o]!==n[o])return!0;return!1})(a||null,e,s)&&i.value++,s=e};return o.tryOnMounted((()=>{r.addChangeListener(l)})),o.tryOnUnmounted((()=>{r.removeChangeListener(l)})),{get:(...e)=>(u&&a&&!a.includes(e[0])&&a.push(e[0]),i.value,r.get(e[0],Object.assign({doNotParse:n},e[1]))),getAll:(...e)=>(i.value,r.getAll(Object.assign({doNotParse:n},e[0]))),set:(...e)=>r.set(...e),remove:(...e)=>r.remove(...e),addChangeListener:(...e)=>r.addChangeListener(...e),removeChangeListener:(...e)=>r.removeChangeListener(...e)}}e.createCookies=function(e){const t=new d.default(e?e.headers.cookie:null);return(e,{doNotParse:n=!1,autoUpdateDependencies:o=!1}={})=>m(e,{doNotParse:n,autoUpdateDependencies:o},t)},e.useAxios=function(e,n){const o=t.ref(null),u=t.ref(void 0),r=t.ref(!1),a=t.ref(!1),s=t.ref(),i=l.default.CancelToken.source();return l.default(e,Object.assign(Object.assign({},n),{cancelToken:i.token})).then((e=>{o.value=e,u.value=e.data,r.value=!0})).catch((e=>{s.value=e,r.value=!0})),{response:o,data:u,error:s,finished:r,cancel:e=>{i.cancel(e),a.value=!0},canceled:a}},e.useCookies=m,e.useJwt=function(e,n={}){const o=t.ref(e),{onError:u,fallbackValue:r=null}=n,a=(e,t)=>{try{return c.default(e,t)}catch(e){return null==u||u(e),r}};return{header:t.computed((()=>a(o.value,{header:!0}))),payload:t.computed((()=>a(o.value)))}},e.useNProgress=function(e=null,n){const u=t.isRef(e)?e:t.ref(e),r=t.computed({set:e=>e?f.default.start():f.default.done(),get:()=>o.isNumber(u.value)&&u.value<1});n&&f.default.configure(n);const a=f.default.set;return f.default.set=e=>(u.value=e,a.call(f.default,e)),t.watchEffect((()=>{o.isNumber(u.value)&&a.call(f.default,u.value)})),o.tryOnUnmounted(f.default.remove),{isLoading:r,progress:u,start:f.default.start,done:f.default.done,remove:()=>{u.value=null,f.default.remove()}}},e.useQRCode=function(e,n){const u=t.ref(e),r=t.ref("");return t.watch(u,(async e=>{u.value&&o.isClient&&(r.value=await v.default.toDataURL(e,n))}),{immediate:!0}),r},Object.defineProperty(e,"__esModule",{value:!0})}(this.VueUse=this.VueUse||{},VueDemi,axios,VueUse,UniversalCookie,jwt_decode,nprogress,QRCode);
+!function(e){if(!e.VueDemi){var t={},n=e.Vue;if(n)if("2."===n.version.slice(0,2)){var o=e.VueCompositionAPI;if(o){for(var u in o)t[u]=o[u];t.isVue2=!0,t.isVue3=!1,t.install=function(){},t.Vue=n,t.version=n.version}else console.error("[vue-demi] no VueCompositionAPI instance found, please be sure to import `@vue/composition-api` before `vue-demi`.")}else if("3."===n.version.slice(0,2)){for(var u in n)t[u]=n[u];t.isVue2=!1,t.isVue3=!0,t.install=function(){},t.Vue=n,t.version=n.version}else console.error("[vue-demi] Vue version "+n.version+" is unsupported.");else console.error("[vue-demi] no Vue instance found, please be sure to import `vue` before `vue-demi`.");e.VueDemi=t}}(window),function(e,t,n,o,u,r,s,a){"use strict";function i(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var l=i(n),d=i(u),c=i(r),f=i(s),v=i(a);function m(e,{doNotParse:n=!1,autoUpdateDependencies:u=!1}={},r=new d.default){const s=u?[...e||[]]:e;let a=r.getAll({doNotParse:!0});const i=t.ref(0),l=()=>{const e=r.getAll({doNotParse:!0});(function(e,t,n){if(!e)return!0;for(const o of e)if(t[o]!==n[o])return!0;return!1})(s||null,e,a)&&i.value++,a=e};return o.tryOnMounted((()=>{r.addChangeListener(l)})),o.tryOnUnmounted((()=>{r.removeChangeListener(l)})),{get:(...e)=>(u&&s&&!s.includes(e[0])&&s.push(e[0]),i.value,r.get(e[0],Object.assign({doNotParse:n},e[1]))),getAll:(...e)=>(i.value,r.getAll(Object.assign({doNotParse:n},e[0]))),set:(...e)=>r.set(...e),remove:(...e)=>r.remove(...e),addChangeListener:(...e)=>r.addChangeListener(...e),removeChangeListener:(...e)=>r.removeChangeListener(...e)}}e.createCookies=function(e){const t=new d.default(e?e.headers.cookie:null);return(e,{doNotParse:n=!1,autoUpdateDependencies:o=!1}={})=>m(e,{doNotParse:n,autoUpdateDependencies:o},t)},e.useAxios=function(e,...n){let o={},u=l.default;n.length>0&&("request"in n[0]?u=n[0]:o=n[0]),n.length>1&&"request"in n[1]&&(u=n[1]);const r=t.ref(null),s=t.ref(void 0),a=t.ref(!1),i=t.ref(!1),d=t.ref(),c=l.default.CancelToken.source();return u(e,Object.assign(Object.assign({},o),{cancelToken:c.token})).then((e=>{r.value=e,s.value=e.data,a.value=!0})).catch((e=>{d.value=e,a.value=!0})),{response:r,data:s,error:d,finished:a,cancel:e=>{c.cancel(e),i.value=!0},canceled:i}},e.useCookies=m,e.useJwt=function(e,n={}){const o=t.ref(e),{onError:u,fallbackValue:r=null}=n,s=(e,t)=>{try{return c.default(e,t)}catch(e){return null==u||u(e),r}};return{header:t.computed((()=>s(o.value,{header:!0}))),payload:t.computed((()=>s(o.value)))}},e.useNProgress=function(e=null,n){const u=t.isRef(e)?e:t.ref(e),r=t.computed({set:e=>e?f.default.start():f.default.done(),get:()=>o.isNumber(u.value)&&u.value<1});n&&f.default.configure(n);const s=f.default.set;return f.default.set=e=>(u.value=e,s.call(f.default,e)),t.watchEffect((()=>{o.isNumber(u.value)&&s.call(f.default,u.value)})),o.tryOnUnmounted(f.default.remove),{isLoading:r,progress:u,start:f.default.start,done:f.default.done,remove:()=>{u.value=null,f.default.remove()}}},e.useQRCode=function(e,n){const u=t.ref(e),r=t.ref("");return t.watch(u,(async e=>{u.value&&o.isClient&&(r.value=await v.default.toDataURL(e,n))}),{immediate:!0}),r},Object.defineProperty(e,"__esModule",{value:!0})}(this.VueUse=this.VueUse||{},VueDemi,axios,VueUse,UniversalCookie,jwt_decode,nprogress,QRCode);

package.json

 {
   "name": "@vueuse/integrations",
   "description": "Integration wrappers for utility libraries",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "main": "./dist/index.cjs.js",
@@ -30,3 +30,3 @@ "types": "./dist/index.d.ts",
   "dependencies": {
-    "@vueuse/shared": "4.2.1",
+    "@vueuse/shared": "4.2.2",
     "vue-demi": "latest"
@@ -33,0 +33,0 @@ },

README.md

@@ -17,7 +17,7 @@ # @vueuse/integrations
 <!--FUNCTIONS_LIST_STARTS-->
-  - [`useAxios`](https://vueuse.js.org/integrations/useAxios/) — wrapper for [`axios`](https://github.com/axios/axios)
-  - [`useCookies`](https://vueuse.js.org/integrations/useCookies/) — wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)
-  - [`useJwt`](https://vueuse.js.org/integrations/useJwt/) — wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode)
-  - [`useNProgress`](https://vueuse.js.org/integrations/useNProgress/) — reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress)
-  - [`useQRCode`](https://vueuse.js.org/integrations/useQRCode/) — wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)
+  - [`useAxios`](https://vueuse.org/integrations/useAxios/) — wrapper for [`axios`](https://github.com/axios/axios)
+  - [`useCookies`](https://vueuse.org/integrations/useCookies/) — wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)
+  - [`useJwt`](https://vueuse.org/integrations/useJwt/) — wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode)
+  - [`useNProgress`](https://vueuse.org/integrations/useNProgress/) — reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress)
+  - [`useQRCode`](https://vueuse.org/integrations/useQRCode/) — wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)
 
@@ -24,0 +24,0 @@

No alert changes

Improved metrics

Total package byte prevSize

39071

increased by4.94%

Lines of code

834

increased by5.84%

Dependency changes

• + Added@vueuse/shared@4.2.2(transitive)

• - Removed@vueuse/shared@4.2.1(transitive)

• Updated@vueuse/shared@4.2.2