ut2 1.18.0 → 1.19.0

package/es/index.js

@@ -30,6 +30,7 @@ export { default as before } from './before.js';
 export { default as curry } from './curry.js';
 export { default as debounce } from './debounce.js';
 export { default as delay } from './delay.js';
+export { default as limit } from './limit.js';
 export { default as memoize } from './memoize.js';
 export { default as negate } from './negate.js';
 export { default as once } from './once.js';

package/es/internals/helpers.js

@@ -2,7 +2,7 @@ import isObjectLike from '../isObjectLike.js';
 import getTag from './getTag.js';
 import { argumentsTag, functionProtoToString, stringUndefined } from './native.js';
 
-var VERSION = "1.18.0";
+var VERSION = "1.19.0";
 var isBrowser = typeof window !== stringUndefined && isObjectLike(window) && typeof document !== stringUndefined && isObjectLike(document) && window.document === document;
 var supportedArgumentsType = getTag((function () { return arguments; })()) === argumentsTag;
 var FUNC_ERROR_TEXT = 'Expected a function';

package/es/limit.js

@@ -0,0 +1,21 @@
+import { __spreadArray, __read } from 'tslib';
+
+function limit(fn, timespan) {
+    var pending = false;
+    function limited() {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        if (pending)
+            return;
+        pending = true;
+        fn.apply(void 0, __spreadArray([], __read(args), false));
+        setTimeout(function () {
+            pending = false;
+        }, timespan);
+    }
+    return limited;
+}
+
+export { limit as default };

package/lib/index.js

@@ -32,6 +32,7 @@ var before = require('./before.js');
 var curry = require('./curry.js');
 var debounce = require('./debounce.js');
 var delay = require('./delay.js');
+var limit = require('./limit.js');
 var memoize = require('./memoize.js');
 var negate = require('./negate.js');
 var once = require('./once.js');
@@ -183,6 +184,7 @@ exports.before = before;
 exports.curry = curry;
 exports.debounce = debounce;
 exports.delay = delay;
+exports.limit = limit;
 exports.memoize = memoize;
 exports.negate = negate;
 exports.once = once;

package/lib/internals/helpers.js

@@ -4,7 +4,7 @@ var isObjectLike = require('../isObjectLike.js');
 var getTag = require('./getTag.js');
 var native = require('./native.js');
 
-var VERSION = "1.18.0";
+var VERSION = "1.19.0";
 var isBrowser = typeof window !== native.stringUndefined && isObjectLike(window) && typeof document !== native.stringUndefined && isObjectLike(document) && window.document === document;
 var supportedArgumentsType = getTag((function () { return arguments; })()) === native.argumentsTag;
 var FUNC_ERROR_TEXT = 'Expected a function';

package/lib/limit.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var tslib = require('tslib');
+
+function limit(fn, timespan) {
+    var pending = false;
+    function limited() {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        if (pending)
+            return;
+        pending = true;
+        fn.apply(void 0, tslib.__spreadArray([], tslib.__read(args), false));
+        setTimeout(function () {
+            pending = false;
+        }, timespan);
+    }
+    return limited;
+}
+
+module.exports = limit;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ut2",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "author": "caijf",
   "license": "MIT",
   "main": "lib/index.js",

package/types/index.d.ts

@@ -48,6 +48,7 @@ export { default as before } from './before';
 export { default as curry } from './curry';
 export { default as debounce } from './debounce';
 export { default as delay } from './delay';
+export { default as limit } from './limit';
 export { default as memoize } from './memoize';
 export { default as negate } from './negate';
 export { default as once } from './once';

package/types/limit.d.ts

@@ -0,0 +1,28 @@
+import { FunctionAny } from './internals/types';
+/**
+ * 创建一个限流函数，该函数在时间间隔内只会执行一次。
+ *
+ * 与 `throttle` 的区别：
+ * 1. 在时间间隔内再次调用，`limit`不会执行，而`throttle` 会执行；
+ * 2. `limit` 没有取消和立即执行的方法，逻辑更简洁。
+ *
+ * @alias module:Function.limit
+ * @since 1.19.0
+ * @param {Function} fn 要限流的函数。
+ * @param {number} timespan 限流的时间间隔，单位为毫秒。
+ * @returns 限流函数。
+ * @example
+ * function revalidate(){
+ *   if(document.visibilityState !== 'hidden' || navigator.onLine){
+ *     // do something
+ *     console.log('revalidate');
+ *   }
+ * }
+ *
+ * // 限制 5s 内只会执行一次
+ * const limited = limit(revalidate, 5000);
+ *
+ * window.addEventListener('visibilitychange', limited);
+ * window.addEventListener('focus', limited);
+ */
+export default function limit<T extends FunctionAny>(fn: T, timespan: number): (...args: Parameters<T>) => void;