@vueuse/core - npm Package Compare versions

Comparing version 3.0.0-alpha.5 to 3.0.0-alpha.7

dist/main/useIntervalFn/index.d.ts

+export declare function useIntervalFn(cb: Function, interval?: number, startRightNow?: boolean): {
+    readonly start: () => void;
+    readonly stop: () => void;
+};

dist/main/useIntervalFn/index.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var api_1 = require("../api");
+function useIntervalFn(cb, interval, startRightNow) {
+    if (interval === void 0) { interval = 1000; }
+    if (startRightNow === void 0) { startRightNow = true; }
+    var timer = null;
+    function stop() {
+        if (timer) {
+            clearInterval(timer);
+            timer = null;
+        }
+    }
+    function start() {
+        stop();
+        timer = setInterval(cb, interval);
+    }
+    if (startRightNow)
+        start();
+    if (api_1.getCurrentInstance())
+        api_1.onUnmounted(stop);
+    return { start: start, stop: stop };
+}
+exports.useIntervalFn = useIntervalFn;
+//# sourceMappingURL=index.js.map

dist/main/useIntervalFn/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useIntervalFn/index.ts"],"names":[],"mappings":";;AAAA,8BAAwD;AAExD,SAAgB,aAAa,CAAE,EAAY,EAAE,QAAe,EAAE,aAAoB;IAArC,yBAAA,EAAA,eAAe;IAAE,8BAAA,EAAA,oBAAoB;IAChF,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,IAAI;QACX,IAAI,KAAK,EAAE;YACT,aAAa,CAAC,KAAK,CAAC,CAAA;YACpB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,IAAI,EAAE,CAAA;QACN,KAAK,GAAG,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;IACnC,CAAC;IAED,IAAI,aAAa;QACf,KAAK,EAAE,CAAA;IAET,IAAI,wBAAkB,EAAE;QACtB,iBAAW,CAAC,IAAI,CAAC,CAAA;IAEnB,OAAO,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAW,CAAA;AACjC,CAAC;AAtBD,sCAsBC"}

dist/main/useWindowSize/index.d.ts

+export declare function useWindowSize(initialWidth?: number, initialHeight?: number): {
+    width: import("@vue/reactivity").Ref<number>;
+    height: import("@vue/reactivity").Ref<number>;
+};

dist/main/useWindowSize/index.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var api_1 = require("../api");
+var utils_1 = require("../utils");
+function useWindowSize(initialWidth, initialHeight) {
+    if (initialWidth === void 0) { initialWidth = Infinity; }
+    if (initialHeight === void 0) { initialHeight = Infinity; }
+    var width = api_1.ref(utils_1.isClient ? window.innerWidth : initialWidth);
+    var height = api_1.ref(utils_1.isClient ? window.innerWidth : initialHeight);
+    if (utils_1.isClient) {
+        var handler_1 = function () {
+            width.value = window.innerWidth;
+            height.value = window.innerHeight;
+        };
+        window.addEventListener('resize', handler_1);
+        api_1.onUnmounted(function () {
+            window.removeEventListener('resize', handler_1);
+        });
+    }
+    return { width: width, height: height };
+}
+exports.useWindowSize = useWindowSize;
+//# sourceMappingURL=index.js.map

dist/main/useWindowSize/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useWindowSize/index.ts"],"names":[],"mappings":";;AAAA,8BAAyC;AACzC,kCAAmC;AAEnC,SAAgB,aAAa,CAAE,YAAuB,EAAE,aAAwB;IAAjD,6BAAA,EAAA,uBAAuB;IAAE,8BAAA,EAAA,wBAAwB;IAC9E,IAAM,KAAK,GAAG,SAAG,CAAC,gBAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;IAC9D,IAAM,MAAM,GAAG,SAAG,CAAC,gBAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;IAEhE,IAAI,gBAAQ,EAAE;QACZ,IAAM,SAAO,GAAG;YACd,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,UAAU,CAAA;YAC/B,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAA;QACnC,CAAC,CAAA;QAED,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAO,CAAC,CAAA;QAE1C,iBAAW,CAAC;YACV,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,SAAO,CAAC,CAAA;QAC/C,CAAC,CAAC,CAAA;KACH;IAED,OAAO,EAAE,KAAK,OAAA,EAAE,MAAM,QAAA,EAAE,CAAA;AAC1B,CAAC;AAlBD,sCAkBC"}

dist/main/utils/index.d.ts

+export declare const isClient: boolean;
+export declare const isDef: <T = any>(val?: T | undefined) => val is T;
+export declare const assert: (condition: boolean, ...infos: any[]) => void;
+export declare const isBoolean: (val: any) => val is boolean;
+export declare const isNumber: (val: any) => val is number;
+export declare const isString: (val: unknown) => val is string;
+export declare const isObject: (val: any) => val is object;
+export declare const isWindow: (val: any) => val is Window;
+export declare const now: () => number;

dist/main/utils/index.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isClient = typeof window === 'object';
+exports.isDef = function (val) { return typeof val !== 'undefined'; };
+exports.assert = function (condition) {
+    var infos = [];
+    for (var _i = 1; _i < arguments.length; _i++) {
+        infos[_i - 1] = arguments[_i];
+    }
+    if (!condition)
+        console.warn.apply(console, infos);
+};
+var toString = Object.prototype.toString;
+exports.isBoolean = function (val) { return typeof val === 'boolean'; };
+exports.isNumber = function (val) { return typeof val === 'number'; };
+exports.isString = function (val) { return typeof val === 'string'; };
+exports.isObject = function (val) {
+    return toString.call(val) === '[object Object]';
+};
+exports.isWindow = function (val) {
+    return typeof window !== 'undefined' && toString.call(val) === '[object Window]';
+};
+exports.now = function () { return Date.now(); };
+//# sourceMappingURL=index.js.map

dist/main/utils/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;AACa,QAAA,QAAQ,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAA;AACrC,QAAA,KAAK,GAAG,UAAU,GAAO,IAAe,OAAA,OAAO,GAAG,KAAK,WAAW,EAA1B,CAA0B,CAAA;AAClE,QAAA,MAAM,GAAG,UAAC,SAAkB;IAAE,eAAe;SAAf,UAAe,EAAf,qBAAe,EAAf,IAAe;QAAf,8BAAe;;IACxD,IAAI,CAAC,SAAS;QAAE,OAAO,CAAC,IAAI,OAAZ,OAAO,EAAS,KAAK,EAAC;AACxC,CAAC,CAAA;AACD,IAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAA;AAC7B,QAAA,SAAS,GAAG,UAAC,GAAQ,IAAqB,OAAA,OAAO,GAAG,KAAK,SAAS,EAAxB,CAAwB,CAAA;AAClE,QAAA,QAAQ,GAAG,UAAC,GAAQ,IAAoB,OAAA,OAAO,GAAG,KAAK,QAAQ,EAAvB,CAAuB,CAAA;AAC/D,QAAA,QAAQ,GAAG,UAAC,GAAY,IAAoB,OAAA,OAAO,GAAG,KAAK,QAAQ,EAAvB,CAAuB,CAAA;AACnE,QAAA,QAAQ,GAAG,UAAC,GAAQ;IAC/B,OAAA,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,iBAAiB;AAAxC,CAAwC,CAAA;AAC7B,QAAA,QAAQ,GAAG,UAAC,GAAQ;IAC/B,OAAA,OAAO,MAAM,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,iBAAiB;AAAzE,CAAyE,CAAA;AAC9D,QAAA,GAAG,GAAG,cAAM,OAAA,IAAI,CAAC,GAAG,EAAE,EAAV,CAAU,CAAA"}

dist/module/useIntervalFn/index.d.ts

+export declare function useIntervalFn(cb: Function, interval?: number, startRightNow?: boolean): {
+    readonly start: () => void;
+    readonly stop: () => void;
+};

dist/module/useIntervalFn/index.js

+import { onUnmounted, getCurrentInstance } from '../api';
+export function useIntervalFn(cb, interval, startRightNow) {
+    if (interval === void 0) { interval = 1000; }
+    if (startRightNow === void 0) { startRightNow = true; }
+    var timer = null;
+    function stop() {
+        if (timer) {
+            clearInterval(timer);
+            timer = null;
+        }
+    }
+    function start() {
+        stop();
+        timer = setInterval(cb, interval);
+    }
+    if (startRightNow)
+        start();
+    if (getCurrentInstance())
+        onUnmounted(stop);
+    return { start: start, stop: stop };
+}
+//# sourceMappingURL=index.js.map

dist/module/useIntervalFn/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useIntervalFn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAExD,MAAM,UAAU,aAAa,CAAE,EAAY,EAAE,QAAe,EAAE,aAAoB;IAArC,yBAAA,EAAA,eAAe;IAAE,8BAAA,EAAA,oBAAoB;IAChF,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,IAAI;QACX,IAAI,KAAK,EAAE;YACT,aAAa,CAAC,KAAK,CAAC,CAAA;YACpB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,IAAI,EAAE,CAAA;QACN,KAAK,GAAG,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;IACnC,CAAC;IAED,IAAI,aAAa;QACf,KAAK,EAAE,CAAA;IAET,IAAI,kBAAkB,EAAE;QACtB,WAAW,CAAC,IAAI,CAAC,CAAA;IAEnB,OAAO,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAW,CAAA;AACjC,CAAC"}

dist/module/useWindowSize/index.d.ts

+export declare function useWindowSize(initialWidth?: number, initialHeight?: number): {
+    width: import("@vue/reactivity").Ref<number>;
+    height: import("@vue/reactivity").Ref<number>;
+};

dist/module/useWindowSize/index.js

+import { onUnmounted, ref } from '../api';
+import { isClient } from '../utils';
+export function useWindowSize(initialWidth, initialHeight) {
+    if (initialWidth === void 0) { initialWidth = Infinity; }
+    if (initialHeight === void 0) { initialHeight = Infinity; }
+    var width = ref(isClient ? window.innerWidth : initialWidth);
+    var height = ref(isClient ? window.innerWidth : initialHeight);
+    if (isClient) {
+        var handler_1 = function () {
+            width.value = window.innerWidth;
+            height.value = window.innerHeight;
+        };
+        window.addEventListener('resize', handler_1);
+        onUnmounted(function () {
+            window.removeEventListener('resize', handler_1);
+        });
+    }
+    return { width: width, height: height };
+}
+//# sourceMappingURL=index.js.map

dist/module/useWindowSize/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useWindowSize/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,MAAM,UAAU,aAAa,CAAE,YAAuB,EAAE,aAAwB;IAAjD,6BAAA,EAAA,uBAAuB;IAAE,8BAAA,EAAA,wBAAwB;IAC9E,IAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;IAC9D,IAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAA;IAEhE,IAAI,QAAQ,EAAE;QACZ,IAAM,SAAO,GAAG;YACd,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,UAAU,CAAA;YAC/B,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAA;QACnC,CAAC,CAAA;QAED,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAO,CAAC,CAAA;QAE1C,WAAW,CAAC;YACV,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,SAAO,CAAC,CAAA;QAC/C,CAAC,CAAC,CAAA;KACH;IAED,OAAO,EAAE,KAAK,OAAA,EAAE,MAAM,QAAA,EAAE,CAAA;AAC1B,CAAC"}

dist/module/utils/index.d.ts

+export declare const isClient: boolean;
+export declare const isDef: <T = any>(val?: T | undefined) => val is T;
+export declare const assert: (condition: boolean, ...infos: any[]) => void;
+export declare const isBoolean: (val: any) => val is boolean;
+export declare const isNumber: (val: any) => val is number;
+export declare const isString: (val: unknown) => val is string;
+export declare const isObject: (val: any) => val is object;
+export declare const isWindow: (val: any) => val is Window;
+export declare const now: () => number;

dist/module/utils/index.js

+export var isClient = typeof window === 'object';
+export var isDef = function (val) { return typeof val !== 'undefined'; };
+export var assert = function (condition) {
+    var infos = [];
+    for (var _i = 1; _i < arguments.length; _i++) {
+        infos[_i - 1] = arguments[_i];
+    }
+    if (!condition)
+        console.warn.apply(console, infos);
+};
+var toString = Object.prototype.toString;
+export var isBoolean = function (val) { return typeof val === 'boolean'; };
+export var isNumber = function (val) { return typeof val === 'number'; };
+export var isString = function (val) { return typeof val === 'string'; };
+export var isObject = function (val) {
+    return toString.call(val) === '[object Object]';
+};
+export var isWindow = function (val) {
+    return typeof window !== 'undefined' && toString.call(val) === '[object Window]';
+};
+export var now = function () { return Date.now(); };
+//# sourceMappingURL=index.js.map

dist/module/utils/index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,IAAM,QAAQ,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAA;AAClD,MAAM,CAAC,IAAM,KAAK,GAAG,UAAU,GAAO,IAAe,OAAA,OAAO,GAAG,KAAK,WAAW,EAA1B,CAA0B,CAAA;AAC/E,MAAM,CAAC,IAAM,MAAM,GAAG,UAAC,SAAkB;IAAE,eAAe;SAAf,UAAe,EAAf,qBAAe,EAAf,IAAe;QAAf,8BAAe;;IACxD,IAAI,CAAC,SAAS;QAAE,OAAO,CAAC,IAAI,OAAZ,OAAO,EAAS,KAAK,EAAC;AACxC,CAAC,CAAA;AACD,IAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAA;AAC1C,MAAM,CAAC,IAAM,SAAS,GAAG,UAAC,GAAQ,IAAqB,OAAA,OAAO,GAAG,KAAK,SAAS,EAAxB,CAAwB,CAAA;AAC/E,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,GAAQ,IAAoB,OAAA,OAAO,GAAG,KAAK,QAAQ,EAAvB,CAAuB,CAAA;AAC5E,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,GAAY,IAAoB,OAAA,OAAO,GAAG,KAAK,QAAQ,EAAvB,CAAuB,CAAA;AAChF,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,GAAQ;IAC/B,OAAA,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,iBAAiB;AAAxC,CAAwC,CAAA;AAC1C,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,GAAQ;IAC/B,OAAA,OAAO,MAAM,KAAK,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,iBAAiB;AAAzE,CAAyE,CAAA;AAC3E,MAAM,CAAC,IAAM,GAAG,GAAG,cAAM,OAAA,IAAI,CAAC,GAAG,EAAE,EAAV,CAAU,CAAA"}

dist/main/index.d.ts

@@ -7,1 +7,3 @@ export { init } from './api';
 export * from './useTimeoutFn';
+export * from './useIntervalFn';
+export * from './useWindowSize';

dist/main/index.js

@@ -13,2 +13,4 @@ "use strict";
 __export(require("./useTimeoutFn"));
+__export(require("./useIntervalFn"));
+__export(require("./useWindowSize"));
 //# sourceMappingURL=index.js.map

dist/main/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;AAAA,6BAA4B;AAAnB,qBAAA,IAAI,CAAA;AACb,8BAAwB;AACxB,8BAAwB;AACxB,kCAA4B;AAC5B,kCAA4B;AAC5B,oCAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;AAAA,6BAA4B;AAAnB,qBAAA,IAAI,CAAA;AACb,8BAAwB;AACxB,8BAAwB;AACxB,kCAA4B;AAC5B,kCAA4B;AAC5B,oCAA8B;AAC9B,qCAA+B;AAC/B,qCAA+B"}

dist/main/useTimeout/index.d.ts

@@ -1,1 +0,5 @@
-export declare function useTimeout(ms?: number): readonly [import("@vue/reactivity").Ref<boolean>, () => void, () => void];
+export declare function useTimeout(interval?: number, startRightNow?: boolean): {
+    readonly ready: import("@vue/reactivity").Ref<boolean>;
+    readonly start: () => void;
+    readonly stop: () => void;
+};

dist/main/useTimeout/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var api_1 = require("../api");
-function useTimeout(ms) {
-    if (ms === void 0) { ms = 1000; }
+function useTimeout(interval, startRightNow) {
+    if (interval === void 0) { interval = 1000; }
+    if (startRightNow === void 0) { startRightNow = true; }
     var ready = api_1.ref(false);
     var timer = null;
-    function clear() {
+    function stop() {
+        ready.value = false;
         if (timer) {
-            ready.value = false;
             clearTimeout(timer);
@@ -16,17 +17,15 @@ timer = null;
     function start() {
-        clear();
+        stop();
         timer = setTimeout(function () {
             ready.value = true;
-        }, ms);
+            timer = null;
+        }, interval);
     }
-    start();
+    if (startRightNow)
+        start();
     if (api_1.getCurrentInstance())
-        api_1.onUnmounted(clear);
-    return [
-        ready,
-        clear,
-        start,
-    ];
+        api_1.onUnmounted(stop);
+    return { ready: ready, start: start, stop: stop };
 }
 exports.useTimeout = useTimeout;
 //# sourceMappingURL=index.js.map

dist/main/useTimeout/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeout/index.ts"],"names":[],"mappings":";;AAAA,8BAA6D;AAE7D,SAAgB,UAAU,CAAE,EAAS;IAAT,mBAAA,EAAA,SAAS;IACnC,IAAM,KAAK,GAAG,SAAG,CAAC,KAAK,CAAC,CAAA;IAExB,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,KAAK;QACZ,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;YACnB,YAAY,CAAC,KAAK,CAAC,CAAA;YACnB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,KAAK,EAAE,CAAA;QACP,KAAK,GAAG,UAAU,CAAC;YACjB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAA;QACpB,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAED,KAAK,EAAE,CAAA;IAEP,IAAI,wBAAkB,EAAE;QACtB,iBAAW,CAAC,KAAK,CAAC,CAAA;IAEpB,OAAO;QACL,KAAK;QACL,KAAK;QACL,KAAK;KACG,CAAA;AACZ,CAAC;AA9BD,gCA8BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeout/index.ts"],"names":[],"mappings":";;AAAA,8BAA6D;AAE7D,SAAgB,UAAU,CAAE,QAAe,EAAE,aAAoB;IAArC,yBAAA,EAAA,eAAe;IAAE,8BAAA,EAAA,oBAAoB;IAC/D,IAAM,KAAK,GAAG,SAAG,CAAC,KAAK,CAAC,CAAA;IAExB,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,IAAI;QACX,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;QACnB,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAA;YACnB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,IAAI,EAAE,CAAA;QACN,KAAK,GAAG,UAAU,CAAC;YACjB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAA;YAClB,KAAK,GAAG,IAAI,CAAA;QACd,CAAC,EAAE,QAAQ,CAAC,CAAA;IACd,CAAC;IAED,IAAI,aAAa;QACf,KAAK,EAAE,CAAA;IAET,IAAI,wBAAkB,EAAE;QACtB,iBAAW,CAAC,IAAI,CAAC,CAAA;IAEnB,OAAO,EAAE,KAAK,OAAA,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAW,CAAA;AACxC,CAAC;AA5BD,gCA4BC"}

dist/main/useTimeoutFn/index.d.ts

@@ -1,2 +0,5 @@
-import { Ref } from '../api';
-export declare function useTimeoutFn(cb: () => any, ms?: number): [() => any, () => any, Ref<boolean>];
+export declare function useTimeoutFn(cb: () => any, interval?: number): {
+    ready: import("@vue/reactivity").Ref<boolean>;
+    start: () => void;
+    stop: () => void;
+};

dist/main/useTimeoutFn/index.js

@@ -5,10 +5,10 @@ "use strict";
 var __1 = require("..");
-function useTimeoutFn(cb, ms) {
-    var _a = __1.useTimeout(ms), ready = _a[0], clear = _a[1], runAgain = _a[2];
+function useTimeoutFn(cb, interval) {
+    var _a = __1.useTimeout(interval), ready = _a.ready, start = _a.start, stop = _a.stop;
     api_1.watch(ready, function (maturity) {
         maturity && cb();
     }, { lazy: true });
-    return [clear, runAgain, ready];
+    return { ready: ready, start: start, stop: stop };
 }
 exports.useTimeoutFn = useTimeoutFn;
 //# sourceMappingURL=index.js.map

dist/main/useTimeoutFn/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeoutFn/index.ts"],"names":[],"mappings":";;AAAA,8BAAmC;AACnC,wBAA+B;AAE/B,SAAgB,YAAY,CAC1B,EAAa,EACb,EAAW;IAEL,IAAA,uBAAyC,EAAxC,aAAK,EAAE,aAAK,EAAE,gBAA0B,CAAA;IAE/C,WAAK,CACH,KAAK,EACL,UAAC,QAAQ;QACP,QAAQ,IAAI,EAAE,EAAE,CAAA;IAClB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAA;IAED,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AACjC,CAAC;AAfD,oCAeC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeoutFn/index.ts"],"names":[],"mappings":";;AAAA,8BAA8B;AAC9B,wBAA+B;AAE/B,SAAgB,YAAY,CAC1B,EAAa,EACb,QAAiB;IAEX,IAAA,6BAA6C,EAA3C,gBAAK,EAAE,gBAAK,EAAE,cAA6B,CAAA;IAEnD,WAAK,CACH,KAAK,EACL,UAAC,QAAQ;QACP,QAAQ,IAAI,EAAE,EAAE,CAAA;IAClB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAA;IAED,OAAO,EAAE,KAAK,OAAA,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAE,CAAA;AAC/B,CAAC;AAfD,oCAeC"}

dist/module/index.d.ts

@@ -7,1 +7,3 @@ export { init } from './api';
 export * from './useTimeoutFn';
+export * from './useIntervalFn';
+export * from './useWindowSize';

dist/module/index.js

@@ -7,2 +7,4 @@ export { init } from './api';
 export * from './useTimeoutFn';
+export * from './useIntervalFn';
+export * from './useWindowSize';
 //# sourceMappingURL=index.js.map

dist/module/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA"}

dist/module/useTimeout/index.d.ts

@@ -1,1 +0,5 @@
-export declare function useTimeout(ms?: number): readonly [import("@vue/reactivity").Ref<boolean>, () => void, () => void];
+export declare function useTimeout(interval?: number, startRightNow?: boolean): {
+    readonly ready: import("@vue/reactivity").Ref<boolean>;
+    readonly start: () => void;
+    readonly stop: () => void;
+};

dist/module/useTimeout/index.js

 import { ref, onUnmounted, getCurrentInstance } from '../api';
-export function useTimeout(ms) {
-    if (ms === void 0) { ms = 1000; }
+export function useTimeout(interval, startRightNow) {
+    if (interval === void 0) { interval = 1000; }
+    if (startRightNow === void 0) { startRightNow = true; }
     var ready = ref(false);
     var timer = null;
-    function clear() {
+    function stop() {
+        ready.value = false;
         if (timer) {
-            ready.value = false;
             clearTimeout(timer);
@@ -14,16 +15,14 @@ timer = null;
     function start() {
-        clear();
+        stop();
         timer = setTimeout(function () {
             ready.value = true;
-        }, ms);
+            timer = null;
+        }, interval);
     }
-    start();
+    if (startRightNow)
+        start();
     if (getCurrentInstance())
-        onUnmounted(clear);
-    return [
-        ready,
-        clear,
-        start,
-    ];
+        onUnmounted(stop);
+    return { ready: ready, start: start, stop: stop };
 }
 //# sourceMappingURL=index.js.map

dist/module/useTimeout/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeout/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAE7D,MAAM,UAAU,UAAU,CAAE,EAAS;IAAT,mBAAA,EAAA,SAAS;IACnC,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;IAExB,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,KAAK;QACZ,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;YACnB,YAAY,CAAC,KAAK,CAAC,CAAA;YACnB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,KAAK,EAAE,CAAA;QACP,KAAK,GAAG,UAAU,CAAC;YACjB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAA;QACpB,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAED,KAAK,EAAE,CAAA;IAEP,IAAI,kBAAkB,EAAE;QACtB,WAAW,CAAC,KAAK,CAAC,CAAA;IAEpB,OAAO;QACL,KAAK;QACL,KAAK;QACL,KAAK;KACG,CAAA;AACZ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeout/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAE7D,MAAM,UAAU,UAAU,CAAE,QAAe,EAAE,aAAoB;IAArC,yBAAA,EAAA,eAAe;IAAE,8BAAA,EAAA,oBAAoB;IAC/D,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;IAExB,IAAI,KAAK,GAAQ,IAAI,CAAA;IAErB,SAAS,IAAI;QACX,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;QACnB,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAA;YACnB,KAAK,GAAG,IAAI,CAAA;SACb;IACH,CAAC;IAED,SAAS,KAAK;QACZ,IAAI,EAAE,CAAA;QACN,KAAK,GAAG,UAAU,CAAC;YACjB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAA;YAClB,KAAK,GAAG,IAAI,CAAA;QACd,CAAC,EAAE,QAAQ,CAAC,CAAA;IACd,CAAC;IAED,IAAI,aAAa;QACf,KAAK,EAAE,CAAA;IAET,IAAI,kBAAkB,EAAE;QACtB,WAAW,CAAC,IAAI,CAAC,CAAA;IAEnB,OAAO,EAAE,KAAK,OAAA,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAW,CAAA;AACxC,CAAC"}

dist/module/useTimeoutFn/index.d.ts

@@ -1,2 +0,5 @@
-import { Ref } from '../api';
-export declare function useTimeoutFn(cb: () => any, ms?: number): [() => any, () => any, Ref<boolean>];
+export declare function useTimeoutFn(cb: () => any, interval?: number): {
+    ready: import("@vue/reactivity").Ref<boolean>;
+    start: () => void;
+    stop: () => void;
+};

dist/module/useTimeoutFn/index.js

 import { watch } from '../api';
 import { useTimeout } from '..';
-export function useTimeoutFn(cb, ms) {
-    var _a = useTimeout(ms), ready = _a[0], clear = _a[1], runAgain = _a[2];
+export function useTimeoutFn(cb, interval) {
+    var _a = useTimeout(interval), ready = _a.ready, start = _a.start, stop = _a.stop;
     watch(ready, function (maturity) {
         maturity && cb();
     }, { lazy: true });
-    return [clear, runAgain, ready];
+    return { ready: ready, start: start, stop: stop };
 }
 //# sourceMappingURL=index.js.map

dist/module/useTimeoutFn/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeoutFn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAO,MAAM,QAAQ,CAAA;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAE/B,MAAM,UAAU,YAAY,CAC1B,EAAa,EACb,EAAW;IAEL,IAAA,mBAAyC,EAAxC,aAAK,EAAE,aAAK,EAAE,gBAA0B,CAAA;IAE/C,KAAK,CACH,KAAK,EACL,UAAC,QAAQ;QACP,QAAQ,IAAI,EAAE,EAAE,CAAA;IAClB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAA;IAED,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AACjC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/useTimeoutFn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAE/B,MAAM,UAAU,YAAY,CAC1B,EAAa,EACb,QAAiB;IAEX,IAAA,yBAA6C,EAA3C,gBAAK,EAAE,gBAAK,EAAE,cAA6B,CAAA;IAEnD,KAAK,CACH,KAAK,EACL,UAAC,QAAQ;QACP,QAAQ,IAAI,EAAE,EAAE,CAAA;IAClB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAA;IAED,OAAO,EAAE,KAAK,OAAA,EAAE,KAAK,OAAA,EAAE,IAAI,MAAA,EAAE,CAAA;AAC/B,CAAC"}

package.json

 {
   "name": "@vueuse/core",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.7",
   "description": "Collection of essential Vue Composition API",
@@ -66,2 +66,3 @@ "main": "dist/main/index.js",
     "commander": "^4.0.1",
+    "consola": "^2.11.1",
     "eslint": "6.8.0",
@@ -68,0 +69,0 @@ "eslint-plugin-jest": "23.1.1",

README.md

 <p align="center">
-<img src="./screenshots/logo.png" alt="logo" width="300"/>
+<img src="https://github.com/antfu/vueuse/blob/master/screenshots/logo.png?raw=true" alt="logo" width="300"/>
 </p>
@@ -23,3 +23,3 @@
 
-### Vue 3.x ([vue-next](https://github.com/vuejs/vue-next))
+### for Vue 3.x ([vue-next](https://github.com/vuejs/vue-next))
 
@@ -30,3 +30,3 @@ ```bash
 
-### Vue 2.x with [composition-api](https://github.com/vuejs/composition-api) polyfill
+### for Vue 2.x with [composition-api](https://github.com/vuejs/composition-api) polyfill
 
@@ -36,6 +36,6 @@
 npm i @vue/composition-api
-npm i @vueuse/core@2
+npm i @vueuse/core
 ```
 
-[Register the Composition API Plugin](https://github.com/vuejs/composition-api#usage) before other APIs.
+Please [register the Composition API Plugin](https://github.com/vuejs/composition-api#usage) before other using APIs.
 
@@ -52,3 +52,3 @@ ## ⚡ Functions
 
-More functions to be added. Please keep turned.
+More functions to be added. Please keep turned. (PRs are also welcome!)
 
@@ -55,0 +55,0 @@ ## 📄 License

No alert changes

Improved metrics

Total package byte prevSize

35697

58.89%

Number of package files

63

40%

Lines of code

465

65.48%

Worsened metrics

Dev dependency count

47

2.17%

No dependency changes