@common.js/p-debounce 4.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/p-debounce
+
+The [p-debounce](https://www.npmjs.com/package/p-debounce) package exported as CommonJS modules.
+
+Exported from [p-debounce@4.0.0](https://www.npmjs.com/package/p-debounce/v/4.0.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,72 @@
+declare namespace pDebounce {
+	interface Options {
+		/**
+		Call the `fn` on the [leading edge of the timeout](https://css-tricks.com/debouncing-throttling-explained-examples/#article-header-id-1). Meaning immediately, instead of waiting for `wait` milliseconds.
+
+		@default false
+		*/
+		readonly before?: boolean;
+	}
+}
+
+declare const pDebounce: {
+	/**
+	[Debounce](https://css-tricks.com/debouncing-throttling-explained-examples/) promise-returning & async functions.
+
+	@param fn - Promise-returning/async function to debounce.
+	@param wait - Milliseconds to wait before calling `fn`.
+	@returns A function that delays calling `fn` until after `wait` milliseconds have elapsed since the last time it was called.
+
+	@example
+	```
+	import pDebounce from 'p-debounce';
+
+	const expensiveCall = async input => input;
+
+	const debouncedFn = pDebounce(expensiveCall, 200);
+
+	for (const number of [1, 2, 3]) {
+		console.log(await debouncedFn(number));
+	}
+	//=> 3
+	//=> 3
+	//=> 3
+	```
+	*/
+	<ArgumentsType extends unknown[], ReturnType>(
+		fn: (...arguments: ArgumentsType) => PromiseLike<ReturnType> | ReturnType,
+		wait: number,
+		options?: pDebounce.Options
+	): (...arguments: ArgumentsType) => Promise<ReturnType>;
+
+	/**
+	Execute `function_` unless a previous call is still pending, in which case, return the pending promise. Useful, for example, to avoid processing extra button clicks if the previous one is not complete.
+
+	@param function_ - Promise-returning/async function to debounce.
+
+	@example
+	```
+	import {setTimeout as delay} from 'timers/promises';
+	import pDebounce from 'p-debounce';
+
+	const expensiveCall = async value => {
+		await delay(200);
+		return value;
+	}
+
+	const debouncedFn = pDebounce.promise(expensiveCall);
+
+	for (const number of [1, 2, 3]) {
+		console.log(await debouncedFn(number));
+	}
+	//=> 1
+	//=> 2
+	//=> 3
+	```
+	*/
+	promise<ArgumentsType extends unknown[], ReturnType>(
+		function_: (...arguments: ArgumentsType) => PromiseLike<ReturnType> | ReturnType
+	): (...arguments: ArgumentsType) => Promise<ReturnType>;
+};
+
+export default pDebounce;

package/index.js

@@ -0,0 +1,233 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _asyncToGenerator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+};
+var pDebounce = function(fn, wait) {
+    var options = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {};
+    if (!Number.isFinite(wait)) {
+        throw new TypeError("Expected `wait` to be a finite number");
+    }
+    var leadingValue;
+    var timeout;
+    var resolveList = [];
+    return function pDebounce() {
+        for(var _len = arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+            arguments_[_key] = arguments[_key];
+        }
+        var _this = this;
+        return new Promise(function(resolve) {
+            var shouldCallNow = options.before && !timeout;
+            clearTimeout(timeout);
+            timeout = setTimeout(function() {
+                timeout = null;
+                var result = options.before ? leadingValue : fn.apply(_this, arguments_);
+                var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+                try {
+                    for(var _iterator = resolveList[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                        resolve = _step.value;
+                        resolve(result);
+                    }
+                } catch (err) {
+                    _didIteratorError = true;
+                    _iteratorError = err;
+                } finally{
+                    try {
+                        if (!_iteratorNormalCompletion && _iterator.return != null) {
+                            _iterator.return();
+                        }
+                    } finally{
+                        if (_didIteratorError) {
+                            throw _iteratorError;
+                        }
+                    }
+                }
+                resolveList = [];
+            }, wait);
+            if (shouldCallNow) {
+                leadingValue = fn.apply(_this, arguments_);
+                resolve(leadingValue);
+            } else {
+                resolveList.push(resolve);
+            }
+        });
+    };
+};
+pDebounce.promise = function(function_) {
+    var currentPromise;
+    return /*#__PURE__*/ _asyncToGenerator(function() {
+        var _len, arguments_, _key;
+        var _arguments = arguments;
+        return __generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    for(_len = _arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+                        arguments_[_key] = _arguments[_key];
+                    }
+                    if (currentPromise) {
+                        return [
+                            2,
+                            currentPromise
+                        ];
+                    }
+                    _state.label = 1;
+                case 1:
+                    _state.trys.push([
+                        1,
+                        ,
+                        3,
+                        4
+                    ]);
+                    currentPromise = function_.apply(this, arguments_);
+                    return [
+                        4,
+                        currentPromise
+                    ];
+                case 2:
+                    return [
+                        2,
+                        _state.sent()
+                    ];
+                case 3:
+                    currentPromise = undefined;
+                    return [
+                        7
+                    ];
+                case 4:
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+};
+var _default = pDebounce;

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@common.js/p-debounce",
+  "version": "4.0.0",
+  "description": "p-debounce package exported as CommonJS modules",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "in-range": "^2.0.0",
+    "time-span": "^4.0.0",
+    "tsd": "^0.14.0",
+    "xo": "^0.37.1",
+    "yoctodelay": "^1.1.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "main": "./index.js"
+}