perfect-debounce 0.1.2 → 1.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 - UnJS
+Copyright (c) Pooya Parsa <pooya@pi0.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -21,10 +21,10 @@ Install package:
 npm install perfect-debounce
 
 # yarn
-yarn install perfect-debounce
+yarn add perfect-debounce
 
 # pnpm
-pnpm install perfect-debounce
+pnpm add perfect-debounce
 ```
 
 Import:

package/dist/index.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 const DEBOUNCE_DEFAULTS = {
   trailing: true
 };
@@ -15,7 +13,7 @@ function debounce(fn, wait = 25, options = {}) {
   let resolveList = [];
   let currentPromise;
   let trailingArgs;
-  const applyFn = async (_this, args) => {
+  const applyFn = (_this, args) => {
     currentPromise = _applyPromised(fn, _this, args);
     currentPromise.finally(() => {
       currentPromise = null;

package/dist/index.d.ts

@@ -29,6 +29,6 @@ for (const number of [1, 2, 3]) {
 //=> 3
 ```
 */
-declare function debounce<ArgumentsType extends unknown[], ReturnType>(fn: (...args: ArgumentsType) => PromiseLike<ReturnType> | ReturnType, wait?: number, options?: DebounceOptions): (...args: any[]) => Promise<unknown>;
+declare function debounce<ArgumentsT extends unknown[], ReturnT>(fn: (...args: ArgumentsT) => PromiseLike<ReturnT> | ReturnT, wait?: number, options?: DebounceOptions): (...args: ArgumentsT) => Promise<ReturnT>;
 
 export { DebounceOptions, debounce };

package/dist/index.mjs

@@ -11,7 +11,7 @@ function debounce(fn, wait = 25, options = {}) {
   let resolveList = [];
   let currentPromise;
   let trailingArgs;
-  const applyFn = async (_this, args) => {
+  const applyFn = (_this, args) => {
     currentPromise = _applyPromised(fn, _this, args);
     currentPromise.finally(() => {
       currentPromise = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perfect-debounce",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "",
   "repository": "unjs/perfect-debounce",
   "license": "MIT",
@@ -8,6 +8,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     }
@@ -18,25 +19,26 @@
   "files": [
     "dist"
   ],
-  "dependencies": {},
-  "devDependencies": {
-    "@nuxtjs/eslint-config-typescript": "latest",
-    "c8": "latest",
-    "eslint": "latest",
-    "in-range": "^3.0.0",
-    "standard-version": "latest",
-    "time-span": "^5.0.0",
-    "typescript": "latest",
-    "unbuild": "latest",
-    "vitest": "latest"
-  },
-  "packageManager": "pnpm@6.32.3",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest dev",
-    "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
-    "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish",
+    "lint": "eslint --ext .ts,.js,.mjs,.cjs . && prettier --check src test",
+    "lint:fix": "eslint --ext .ts,.js,.mjs,.cjs . --fix && prettier -w src test",
+    "release": "pnpm test && pnpm build && changelogen --release --push && npm publish",
     "test": "vitest run --coverage"
   },
-  "readme": "# perfect-debounce\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Github Actions][github-actions-src]][github-actions-href]\n[![Codecov][codecov-src]][codecov-href]\n\n> An improved debounce function with Promise support.\n\n- Well tested debounce implementation\n- Native Promise support\n- Avoid duplicate calls while promise is being resolved\n- Configurable `trailing` and `leading` behavior\n\n## Usage\n\nInstall package:\n\n```sh\n# npm\nnpm install perfect-debounce\n\n# yarn\nyarn install perfect-debounce\n\n# pnpm\npnpm install perfect-debounce\n```\n\nImport:\n\n```js\n// ESM\nimport { debounce } from 'perfect-debounce'\n\n// CommonJS\nconst { debounce } = require('perfect-debounce')\n```\n\nDebounce function:\n\n```js\nconst debounced = debounce(async () => {\n  // Some heavy stuff\n}, 25)\n```\n\nWhen calling `debounced`, it will wait at least for `25ms` as configured before actually calling our function. This helps to avoid multiple calls.\n\nTo avoid initial wait, we can set `leading: true` option. It will cause function to be immediately called if there is no other call:\n\n```js\nconst debounced = debounce(async () => {\n  // Some heavy stuff\n}, 25, { leading: true })\n```\n\nIf executing async function takes longer than debounce value, duplicate calls will be still prevented a last call will happen. To disable this behavior, we can set `trailing: false` option:\n\n```js\nconst debounced = debounce(async () => {\n  // Some heavy stuff\n}, 25, { trailing: false })\n```\n\n## 💻 Development\n\n- Clone this repository\n- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)\n- Install dependencies using `pnpm install`\n- Run interactive tests using `pnpm dev`\n\n## License\n\nMade with 💛\n\nBased on [sindresorhus/p-debounce](https://github.com/sindresorhus/p-debounce).\n\nPublished under [MIT License](./LICENSE).\n\n<!-- Badges -->\n[npm-version-src]: https://img.shields.io/npm/v/perfect-debounce?style=flat-square\n[npm-version-href]: https://npmjs.com/package/perfect-debounce\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/perfect-debounce?style=flat-square\n[npm-downloads-href]: https://npmjs.com/package/perfect-debounce\n\n[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/perfect-debounce/ci/main?style=flat-square\n[github-actions-href]: https://github.com/unjs/perfect-debounce/actions?query=workflow%3Aci\n\n[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/perfect-debounce/main?style=flat-square\n[codecov-href]: https://codecov.io/gh/unjs/perfect-debounce\n"
+  "devDependencies": {
+    "@types/node": "^18.16.3",
+    "@vitest/coverage-c8": "^0.31.0",
+    "changelogen": "^0.5.3",
+    "eslint": "^8.39.0",
+    "eslint-config-unjs": "^0.1.0",
+    "in-range": "^3.0.0",
+    "prettier": "^2.8.8",
+    "time-span": "^5.1.0",
+    "typescript": "^5.0.4",
+    "unbuild": "^1.2.1",
+    "vitest": "^0.31.0"
+  },
+  "packageManager": "pnpm@8.4.0"
 }