@common.js/debounce-fn 5.1.2

package/README.md

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

package/index.d.ts

@@ -0,0 +1,81 @@
+export interface Options {
+	/**
+	Time in milliseconds to wait until the `input` function is called.
+
+	@default 0
+	*/
+	readonly wait?: number;
+
+	/**
+	The maximum time the `input` function is allowed to be delayed before it's invoked.
+
+	This can be used to control the rate of calls handled in a constant stream. For example, a media player sending updates every few milliseconds but wants to be handled only once a second.
+
+	@default Infinity
+	*/
+	readonly maxWait?: number;
+
+	/**
+	Trigger the function on the leading edge of the `wait` interval.
+
+	For example, this can be useful for preventing accidental double-clicks on a "submit" button from firing a second time.
+
+	@default false
+	*/
+	readonly before?: boolean;
+
+	/**
+	Trigger the function on the trailing edge of the `wait` interval.
+
+	@default true
+	*/
+	readonly after?: boolean;
+}
+
+export interface BeforeOptions extends Options {
+	readonly before: true;
+}
+
+export interface NoBeforeNoAfterOptions extends Options {
+	readonly after: false;
+	readonly before?: false;
+}
+
+export interface DebouncedFunction<ArgumentsType extends unknown[], ReturnType> {
+	(...arguments: ArgumentsType): ReturnType;
+	cancel(): void;
+}
+
+/**
+[Debounce](https://davidwalsh.name/javascript-debounce-function) a function.
+
+@param input - Function to debounce.
+@returns A debounced function that delays calling the `input` function until after `wait` milliseconds have elapsed since the last time the debounced function was called.
+
+It comes with a `.cancel()` method to cancel any scheduled `input` function calls.
+
+@example
+```
+import debounceFn from 'debounce-fn';
+
+window.onresize = debounceFn(() => {
+	// Do something on window resize
+}, {wait: 100});
+```
+*/
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options: BeforeOptions
+): DebouncedFunction<ArgumentsType, ReturnType>;
+
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options: NoBeforeNoAfterOptions
+): DebouncedFunction<ArgumentsType, undefined>;
+
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options?: Options
+): DebouncedFunction<ArgumentsType, ReturnType | undefined>;
+
+export default debounceFn;

package/index.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+var _mimicFn = /*#__PURE__*/ _interopRequireDefault(require("mimic-fn"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+var debounceFn = function(inputFunction) {
+    var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+    if (typeof inputFunction !== "function") {
+        throw new TypeError("Expected the first argument to be a function, got `".concat(typeof inputFunction === "undefined" ? "undefined" : _typeof(inputFunction), "`"));
+    }
+    var _wait = options.wait, wait = _wait === void 0 ? 0 : _wait, _maxWait = options.maxWait, maxWait = _maxWait === void 0 ? Number.POSITIVE_INFINITY : _maxWait, _before = options.before, before = _before === void 0 ? false : _before, _after = options.after, after = _after === void 0 ? true : _after;
+    if (!before && !after) {
+        throw new Error("Both `before` and `after` are false, function wouldn't be called.");
+    }
+    var timeout;
+    var maxTimeout;
+    var result;
+    var debouncedFunction = function debouncedFunction() {
+        for(var _len = arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+            arguments_[_key] = arguments[_key];
+        }
+        var context = this; // eslint-disable-line unicorn/no-this-assignment
+        var later = function() {
+            timeout = undefined;
+            if (maxTimeout) {
+                clearTimeout(maxTimeout);
+                maxTimeout = undefined;
+            }
+            if (after) {
+                result = inputFunction.apply(context, arguments_);
+            }
+        };
+        var maxLater = function() {
+            maxTimeout = undefined;
+            if (timeout) {
+                clearTimeout(timeout);
+                timeout = undefined;
+            }
+            if (after) {
+                result = inputFunction.apply(context, arguments_);
+            }
+        };
+        var shouldCallNow = before && !timeout;
+        clearTimeout(timeout);
+        timeout = setTimeout(later, wait);
+        if (maxWait > 0 && maxWait !== Number.POSITIVE_INFINITY && !maxTimeout) {
+            maxTimeout = setTimeout(maxLater, maxWait);
+        }
+        if (shouldCallNow) {
+            result = inputFunction.apply(context, arguments_);
+        }
+        return result;
+    };
+    (0, _mimicFn.default)(debouncedFunction, inputFunction);
+    debouncedFunction.cancel = function() {
+        if (timeout) {
+            clearTimeout(timeout);
+            timeout = undefined;
+        }
+        if (maxTimeout) {
+            clearTimeout(maxTimeout);
+            maxTimeout = undefined;
+        }
+    };
+    return debouncedFunction;
+};
+var _default = debounceFn;

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,30 @@
+{
+  "name": "@common.js/debounce-fn",
+  "version": "5.1.2",
+  "description": "Debounce a function",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@common.js/mimic-fn": "^4.0.0"
+  },
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "delay": "^5.0.0",
+    "tsd": "^0.19.1",
+    "xo": "^0.47.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,73 @@
+# debounce-fn
+
+> [Debounce](https://davidwalsh.name/javascript-debounce-function) a function
+
+## Install
+
+```sh
+npm install debounce-fn
+```
+
+## Usage
+
+```js
+import debounceFn from 'debounce-fn';
+
+window.onresize = debounceFn(() => {
+	// Do something on window resize
+}, {wait: 100});
+```
+
+## API
+
+### debounceFn(input, options?)
+
+Returns a debounced function that delays calling the `input` function until after `wait` milliseconds have elapsed since the last time the debounced function was called.
+
+It comes with a `.cancel()` method to cancel any scheduled `input` function calls.
+
+#### input
+
+Type: `Function`
+
+Function to debounce.
+
+#### options
+
+Type: `object`
+
+##### wait
+
+Type: `number`\
+Default: `0`
+
+Time in milliseconds to wait until the `input` function is called.
+
+##### maxWait
+
+Type: `number`\
+Default: `Infinity`
+
+The maximum time the `input` function is allowed to be delayed before it's invoked.
+
+This can be used to limit the number of calls handled in a constant stream. For example, a media player sending updates every few milliseconds but wants to be handled only once a second.
+
+##### before
+
+Type: `boolean`\
+Default: `false`
+
+Trigger the function on the leading edge of the `wait` interval.
+
+For example, can be useful for preventing accidental double-clicks on a "submit" button from firing a second time.
+
+##### after
+
+Type: `boolean`\
+Default: `true`
+
+Trigger the function on the trailing edge of the `wait` interval.
+
+## Related
+
+- [p-debounce](https://github.com/sindresorhus/p-debounce) - Debounce promise-returning & async functions