@common.js/debounce-fn 5.1.2 → 6.0.0

package/README.md

@@ -2,4 +2,4 @@
 
 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.
+Exported from [debounce-fn@6.0.0](https://www.npmjs.com/package/debounce-fn/v/6.0.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -1,4 +1,4 @@
-export interface Options {
+export type Options = {
 	/**
 	Time in milliseconds to wait until the `input` function is called.
 
@@ -30,21 +30,21 @@ export interface Options {
 	@default true
 	*/
 	readonly after?: boolean;
-}
+};
 
-export interface BeforeOptions extends Options {
+export type BeforeOptions = {
 	readonly before: true;
-}
+} & Options;
 
-export interface NoBeforeNoAfterOptions extends Options {
+export type NoBeforeNoAfterOptions = {
 	readonly after: false;
 	readonly before?: false;
-}
+} & Options;
 
-export interface DebouncedFunction<ArgumentsType extends unknown[], ReturnType> {
+export type DebouncedFunction<ArgumentsType extends unknown[], ReturnType> = {
 	(...arguments: ArgumentsType): ReturnType;
 	cancel(): void;
-}
+};
 
 /**
 [Debounce](https://davidwalsh.name/javascript-debounce-function) a function.
@@ -63,19 +63,17 @@ window.onresize = debounceFn(() => {
 }, {wait: 100});
 ```
 */
-declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+export default function debounceFn<ArgumentsType extends unknown[], ReturnType>(
 	input: (...arguments: ArgumentsType) => ReturnType,
 	options: BeforeOptions
 ): DebouncedFunction<ArgumentsType, ReturnType>;
 
-declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+export default function debounceFn<ArgumentsType extends unknown[], ReturnType>(
 	input: (...arguments: ArgumentsType) => ReturnType,
 	options: NoBeforeNoAfterOptions
 ): DebouncedFunction<ArgumentsType, undefined>;
 
-declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+export default function debounceFn<ArgumentsType extends unknown[], ReturnType>(
 	input: (...arguments: ArgumentsType) => ReturnType,
 	options?: Options
 ): DebouncedFunction<ArgumentsType, ReturnType | undefined>;
-
-export default debounceFn;

package/index.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "default", {
         return _default;
     }
 });
-var _mimicFn = /*#__PURE__*/ _interopRequireDefault(require("mimic-fn"));
+var _mimicFunction = /*#__PURE__*/ _interopRequireDefault(require("mimic-function"));
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -18,12 +18,15 @@ var _typeof = function(obj) {
     "@swc/helpers - typeof";
     return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
 };
-var debounceFn = function(inputFunction) {
+var debounceFunction = 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 (wait < 0 || maxWait < 0) {
+        throw new RangeError("`wait` and `maxWait` must not be negative.");
+    }
     if (!before && !after) {
         throw new Error("Both `before` and `after` are false, function wouldn't be called.");
     }
@@ -66,7 +69,7 @@ var debounceFn = function(inputFunction) {
         }
         return result;
     };
-    (0, _mimicFn.default)(debouncedFunction, inputFunction);
+    (0, _mimicFunction.default)(debouncedFunction, inputFunction);
     debouncedFunction.cancel = function() {
         if (timeout) {
             clearTimeout(timeout);
@@ -79,4 +82,4 @@ var debounceFn = function(inputFunction) {
     };
     return debouncedFunction;
 };
-var _default = debounceFn;
+var _default = debounceFunction;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@common.js/debounce-fn",
-  "version": "5.1.2",
-  "description": "Debounce a function",
+  "version": "6.0.0",
+  "description": "debounce-fn package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
   "funding": "https://github.com/sponsors/sindresorhus",
   "type": "commonjs",
+  "sideEffects": false,
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "scripts": {
     "test": "xo && ava && tsd"
@@ -17,14 +18,15 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@common.js/mimic-fn": "^4.0.0"
+    "@common.js/mimic-function": "^5.0.0"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "delay": "^5.0.0",
-    "tsd": "^0.19.1",
-    "xo": "^0.47.0"
+    "ava": "^5.3.1",
+    "delay": "^6.0.0",
+    "tsd": "^0.29.0",
+    "xo": "^0.56.0"
   },
   "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "types": "./index.d.ts",
   "main": "./index.js"
 }

package/readme.md

@@ -1,73 +0,0 @@
-# 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