@x-oasis/throttle 0.0.14

package/README.md

@@ -0,0 +1,19 @@
+# @x-oasis/throttle
+
+## Installation
+
+```bash
+$ npm i @x-oasis/throttle
+```
+
+## How to use
+
+```typescript
+import throttle from '@x-oasis/throttle'
+```
+
+## How to run test
+
+```bash
+$ pnpm test
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export default function throttle(fn: Function, threshold?: number, fallbackOptions?: {
+    persistArgs?: (...args: any[]) => any;
+} | boolean): (...args: any[]) => void;

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./throttle.cjs.production.min.js')
+} else {
+  module.exports = require('./throttle.cjs.development.js')
+}

package/dist/throttle.cjs.development.js

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function throttle(fn, threshold, fallbackOptions) {
+  if (threshold === void 0) {
+    threshold = 250;
+  }
+  var last = 0;
+  var timeoutHandler = null;
+  var fallback = !!fallbackOptions;
+  var queue = [];
+  return function throttled() {
+    var now = Date.now();
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    if (now - last > threshold) {
+      last = now;
+      if (timeoutHandler) {
+        clearTimeout(timeoutHandler);
+        timeoutHandler = null;
+        queue = [];
+      }
+      fn.apply(null, args);
+      return;
+    }
+    if (!fallback) return;
+    timeoutHandler = setTimeout(function () {
+      var len = queue.length;
+      if (len) {
+        var currentArgs = queue[len - 1];
+        queue = [];
+        fn.apply(null, currentArgs);
+      }
+    }, threshold);
+    var nextArgs = args;
+    var persistArgs = typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;
+    if (typeof persistArgs === 'function') {
+      nextArgs = persistArgs(args);
+    }
+    queue.push(nextArgs);
+  };
+}
+
+exports.default = throttle;
+//# sourceMappingURL=throttle.cjs.development.js.map

package/dist/throttle.cjs.development.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttle.cjs.development.js","sources":["../src/index.ts"],"sourcesContent":["/**\n *\n * @param fn\n * @param threshold\n * @returns\n *\n * trigger first, then trigger on the last\n */\n\nexport default function throttle(\n  fn: Function,\n  threshold = 250,\n  fallbackOptions?:\n    | {\n        persistArgs?: (...args: any[]) => any;\n      }\n    | boolean\n) {\n  let last = 0;\n  let timeoutHandler = null;\n  const fallback = !!fallbackOptions;\n\n  let queue = [];\n\n  return function throttled(...args: any[]) {\n    const now = Date.now();\n\n    if (now - last > threshold) {\n      last = now;\n      if (timeoutHandler) {\n        clearTimeout(timeoutHandler);\n        timeoutHandler = null;\n        queue = [];\n      }\n\n      fn.apply(null, args);\n      return;\n    }\n\n    if (!fallback) return;\n\n    timeoutHandler = setTimeout(() => {\n      const len = queue.length;\n      if (len) {\n        const currentArgs = queue[len - 1];\n        queue = [];\n        fn.apply(null, currentArgs);\n      }\n    }, threshold);\n\n    let nextArgs = args;\n    const persistArgs =\n      typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;\n\n    if (typeof persistArgs === 'function') {\n      nextArgs = persistArgs(args);\n    }\n\n    queue.push(nextArgs);\n  };\n}\n"],"names":["throttle","fn","threshold","fallbackOptions","last","timeoutHandler","fallback","queue","throttled","now","Date","_len","arguments","length","args","Array","_key","clearTimeout","apply","setTimeout","len","currentArgs","nextArgs","persistArgs","push"],"mappings":";;;;SASwBA,QAAQA,CAC9BC,EAAY,EACZC,SAAS,EACTC,eAIW;MALXD,SAAS;IAATA,SAAS,GAAG,GAAG;;EAOf,IAAIE,IAAI,GAAG,CAAC;EACZ,IAAIC,cAAc,GAAG,IAAI;EACzB,IAAMC,QAAQ,GAAG,CAAC,CAACH,eAAe;EAElC,IAAII,KAAK,GAAG,EAAE;EAEd,OAAO,SAASC,SAASA;IACvB,IAAMC,GAAG,GAAGC,IAAI,CAACD,GAAG,EAAE;IAAC,SAAAE,IAAA,GAAAC,SAAA,CAAAC,MAAA,EADIC,IAAW,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;MAAXF,IAAW,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;;IAGtC,IAAIP,GAAG,GAAGL,IAAI,GAAGF,SAAS,EAAE;MAC1BE,IAAI,GAAGK,GAAG;MACV,IAAIJ,cAAc,EAAE;QAClBY,YAAY,CAACZ,cAAc,CAAC;QAC5BA,cAAc,GAAG,IAAI;QACrBE,KAAK,GAAG,EAAE;;MAGZN,EAAE,CAACiB,KAAK,CAAC,IAAI,EAAEJ,IAAI,CAAC;MACpB;;IAGF,IAAI,CAACR,QAAQ,EAAE;IAEfD,cAAc,GAAGc,UAAU,CAAC;MAC1B,IAAMC,GAAG,GAAGb,KAAK,CAACM,MAAM;MACxB,IAAIO,GAAG,EAAE;QACP,IAAMC,WAAW,GAAGd,KAAK,CAACa,GAAG,GAAG,CAAC,CAAC;QAClCb,KAAK,GAAG,EAAE;QACVN,EAAE,CAACiB,KAAK,CAAC,IAAI,EAAEG,WAAW,CAAC;;KAE9B,EAAEnB,SAAS,CAAC;IAEb,IAAIoB,QAAQ,GAAGR,IAAI;IACnB,IAAMS,WAAW,GACf,OAAOpB,eAAe,KAAK,QAAQ,GAAGA,eAAe,CAACoB,WAAW,GAAG,IAAI;IAE1E,IAAI,OAAOA,WAAW,KAAK,UAAU,EAAE;MACrCD,QAAQ,GAAGC,WAAW,CAACT,IAAI,CAAC;;IAG9BP,KAAK,CAACiB,IAAI,CAACF,QAAQ,CAAC;GACrB;AACH;;;;"}

package/dist/throttle.cjs.production.min.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=function(e,t,n){void 0===t&&(t=250);var r=0,l=null,u=!!n,o=[];return function(){for(var i=Date.now(),a=arguments.length,f=new Array(a),p=0;p<a;p++)f[p]=arguments[p];if(i-r>t)return r=i,l&&(clearTimeout(l),l=null,o=[]),void e.apply(null,f);if(u){l=setTimeout((function(){var t=o.length;if(t){var n=o[t-1];o=[],e.apply(null,n)}}),t);var s=f,c="object"==typeof n?n.persistArgs:null;"function"==typeof c&&(s=c(f)),o.push(s)}}};
+//# sourceMappingURL=throttle.cjs.production.min.js.map

package/dist/throttle.cjs.production.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttle.cjs.production.min.js","sources":["../src/index.ts"],"sourcesContent":["/**\n *\n * @param fn\n * @param threshold\n * @returns\n *\n * trigger first, then trigger on the last\n */\n\nexport default function throttle(\n  fn: Function,\n  threshold = 250,\n  fallbackOptions?:\n    | {\n        persistArgs?: (...args: any[]) => any;\n      }\n    | boolean\n) {\n  let last = 0;\n  let timeoutHandler = null;\n  const fallback = !!fallbackOptions;\n\n  let queue = [];\n\n  return function throttled(...args: any[]) {\n    const now = Date.now();\n\n    if (now - last > threshold) {\n      last = now;\n      if (timeoutHandler) {\n        clearTimeout(timeoutHandler);\n        timeoutHandler = null;\n        queue = [];\n      }\n\n      fn.apply(null, args);\n      return;\n    }\n\n    if (!fallback) return;\n\n    timeoutHandler = setTimeout(() => {\n      const len = queue.length;\n      if (len) {\n        const currentArgs = queue[len - 1];\n        queue = [];\n        fn.apply(null, currentArgs);\n      }\n    }, threshold);\n\n    let nextArgs = args;\n    const persistArgs =\n      typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;\n\n    if (typeof persistArgs === 'function') {\n      nextArgs = persistArgs(args);\n    }\n\n    queue.push(nextArgs);\n  };\n}\n"],"names":["fn","threshold","fallbackOptions","last","timeoutHandler","fallback","queue","now","Date","_len","arguments","length","args","Array","_key","clearTimeout","apply","setTimeout","len","currentArgs","nextArgs","persistArgs","push"],"mappings":"6FAUEA,EACAC,EACAC,YADAD,IAAAA,EAAY,KAOZ,IAAIE,EAAO,EACPC,EAAiB,KACfC,IAAaH,EAEfI,EAAQ,GAEZ,OAAO,WACkB,IAAvB,IAAMC,EAAMC,KAAKD,MAAME,EAAAC,UAAAC,OADIC,MAAWC,MAAAJ,GAAAK,IAAAA,EAAAL,EAAAK,IAAXF,EAAWE,GAAAJ,UAAAI,GAGtC,GAAIP,EAAMJ,EAAOF,EASf,OARAE,EAAOI,EACHH,IACFW,aAAaX,GACbA,EAAiB,KACjBE,EAAQ,SAGVN,EAAGgB,MAAM,KAAMJ,GAIjB,GAAKP,EAAL,CAEAD,EAAiBa,YAAW,WAC1B,IAAMC,EAAMZ,EAAMK,OAClB,GAAIO,EAAK,CACP,IAAMC,EAAcb,EAAMY,EAAM,GAChCZ,EAAQ,GACRN,EAAGgB,MAAM,KAAMG,MAEhBlB,GAEH,IAAImB,EAAWR,EACTS,EACuB,iBAApBnB,EAA+BA,EAAgBmB,YAAc,KAE3C,mBAAhBA,IACTD,EAAWC,EAAYT,IAGzBN,EAAMgB,KAAKF"}

package/dist/throttle.esm.js

@@ -0,0 +1,43 @@
+function throttle(fn, threshold, fallbackOptions) {
+  if (threshold === void 0) {
+    threshold = 250;
+  }
+  var last = 0;
+  var timeoutHandler = null;
+  var fallback = !!fallbackOptions;
+  var queue = [];
+  return function throttled() {
+    var now = Date.now();
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    if (now - last > threshold) {
+      last = now;
+      if (timeoutHandler) {
+        clearTimeout(timeoutHandler);
+        timeoutHandler = null;
+        queue = [];
+      }
+      fn.apply(null, args);
+      return;
+    }
+    if (!fallback) return;
+    timeoutHandler = setTimeout(function () {
+      var len = queue.length;
+      if (len) {
+        var currentArgs = queue[len - 1];
+        queue = [];
+        fn.apply(null, currentArgs);
+      }
+    }, threshold);
+    var nextArgs = args;
+    var persistArgs = typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;
+    if (typeof persistArgs === 'function') {
+      nextArgs = persistArgs(args);
+    }
+    queue.push(nextArgs);
+  };
+}
+
+export default throttle;
+//# sourceMappingURL=throttle.esm.js.map

package/dist/throttle.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttle.esm.js","sources":["../src/index.ts"],"sourcesContent":["/**\n *\n * @param fn\n * @param threshold\n * @returns\n *\n * trigger first, then trigger on the last\n */\n\nexport default function throttle(\n  fn: Function,\n  threshold = 250,\n  fallbackOptions?:\n    | {\n        persistArgs?: (...args: any[]) => any;\n      }\n    | boolean\n) {\n  let last = 0;\n  let timeoutHandler = null;\n  const fallback = !!fallbackOptions;\n\n  let queue = [];\n\n  return function throttled(...args: any[]) {\n    const now = Date.now();\n\n    if (now - last > threshold) {\n      last = now;\n      if (timeoutHandler) {\n        clearTimeout(timeoutHandler);\n        timeoutHandler = null;\n        queue = [];\n      }\n\n      fn.apply(null, args);\n      return;\n    }\n\n    if (!fallback) return;\n\n    timeoutHandler = setTimeout(() => {\n      const len = queue.length;\n      if (len) {\n        const currentArgs = queue[len - 1];\n        queue = [];\n        fn.apply(null, currentArgs);\n      }\n    }, threshold);\n\n    let nextArgs = args;\n    const persistArgs =\n      typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;\n\n    if (typeof persistArgs === 'function') {\n      nextArgs = persistArgs(args);\n    }\n\n    queue.push(nextArgs);\n  };\n}\n"],"names":["throttle","fn","threshold","fallbackOptions","last","timeoutHandler","fallback","queue","throttled","now","Date","_len","arguments","length","args","Array","_key","clearTimeout","apply","setTimeout","len","currentArgs","nextArgs","persistArgs","push"],"mappings":"SASwBA,QAAQA,CAC9BC,EAAY,EACZC,SAAS,EACTC,eAIW;MALXD,SAAS;IAATA,SAAS,GAAG,GAAG;;EAOf,IAAIE,IAAI,GAAG,CAAC;EACZ,IAAIC,cAAc,GAAG,IAAI;EACzB,IAAMC,QAAQ,GAAG,CAAC,CAACH,eAAe;EAElC,IAAII,KAAK,GAAG,EAAE;EAEd,OAAO,SAASC,SAASA;IACvB,IAAMC,GAAG,GAAGC,IAAI,CAACD,GAAG,EAAE;IAAC,SAAAE,IAAA,GAAAC,SAAA,CAAAC,MAAA,EADIC,IAAW,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;MAAXF,IAAW,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;;IAGtC,IAAIP,GAAG,GAAGL,IAAI,GAAGF,SAAS,EAAE;MAC1BE,IAAI,GAAGK,GAAG;MACV,IAAIJ,cAAc,EAAE;QAClBY,YAAY,CAACZ,cAAc,CAAC;QAC5BA,cAAc,GAAG,IAAI;QACrBE,KAAK,GAAG,EAAE;;MAGZN,EAAE,CAACiB,KAAK,CAAC,IAAI,EAAEJ,IAAI,CAAC;MACpB;;IAGF,IAAI,CAACR,QAAQ,EAAE;IAEfD,cAAc,GAAGc,UAAU,CAAC;MAC1B,IAAMC,GAAG,GAAGb,KAAK,CAACM,MAAM;MACxB,IAAIO,GAAG,EAAE;QACP,IAAMC,WAAW,GAAGd,KAAK,CAACa,GAAG,GAAG,CAAC,CAAC;QAClCb,KAAK,GAAG,EAAE;QACVN,EAAE,CAACiB,KAAK,CAAC,IAAI,EAAEG,WAAW,CAAC;;KAE9B,EAAEnB,SAAS,CAAC;IAEb,IAAIoB,QAAQ,GAAGR,IAAI;IACnB,IAAMS,WAAW,GACf,OAAOpB,eAAe,KAAK,QAAQ,GAAGA,eAAe,CAACoB,WAAW,GAAG,IAAI;IAE1E,IAAI,OAAOA,WAAW,KAAK,UAAU,EAAE;MACrCD,QAAQ,GAAGC,WAAW,CAACT,IAAI,CAAC;;IAG9BP,KAAK,CAACiB,IAAI,CAACF,QAAQ,CAAC;GACrB;AACH;;;;"}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@x-oasis/throttle",
+  "version": "0.0.14",
+  "description": "throttle function",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "module": "dist/throttle.esm.js",
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "tsdx": "^0.14.1"
+  },
+  "scripts": {
+    "build": "tsdx build --tsconfig tsconfig.build.json",
+    "clean": "rimraf ./dist",
+    "test": "vitest",
+    "compile": "tsc -p tsconfig.build.json"
+  }
+}

package/src/index.ts

@@ -0,0 +1,61 @@
+/**
+ *
+ * @param fn
+ * @param threshold
+ * @returns
+ *
+ * trigger first, then trigger on the last
+ */
+
+export default function throttle(
+  fn: Function,
+  threshold = 250,
+  fallbackOptions?:
+    | {
+        persistArgs?: (...args: any[]) => any;
+      }
+    | boolean
+) {
+  let last = 0;
+  let timeoutHandler = null;
+  const fallback = !!fallbackOptions;
+
+  let queue = [];
+
+  return function throttled(...args: any[]) {
+    const now = Date.now();
+
+    if (now - last > threshold) {
+      last = now;
+      if (timeoutHandler) {
+        clearTimeout(timeoutHandler);
+        timeoutHandler = null;
+        queue = [];
+      }
+
+      fn.apply(null, args);
+      return;
+    }
+
+    if (!fallback) return;
+
+    timeoutHandler = setTimeout(() => {
+      const len = queue.length;
+      if (len) {
+        const currentArgs = queue[len - 1];
+        queue = [];
+        fn.apply(null, currentArgs);
+      }
+    }, threshold);
+
+    let nextArgs = args;
+    const persistArgs =
+      typeof fallbackOptions === 'object' ? fallbackOptions.persistArgs : null;
+
+    if (typeof persistArgs === 'function') {
+      nextArgs = persistArgs(args);
+    }
+
+    queue.push(nextArgs);
+  };
+}

package/test/test.spec.ts

@@ -0,0 +1,5 @@
+import { expect, test } from 'vitest';
+
+test('vitest', async () => {
+  expect('vitest').toBe('vitest');
+});

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "esModuleInterop": true
+  },
+
+  "include": [
+    "src/**/*"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "jsx": "react",
+    "esModuleInterop": true
+  }
+}

package/vitest.config.ts

@@ -0,0 +1,26 @@
+// import path from 'path';
+// import tsPath from 'vite-tsconfig-paths';
+import { defineConfig } from 'vitest/config';
+
+// const __dirname = import.meta.url.slice(7, import.meta.url.lastIndexOf('/'));
+
+export default defineConfig({
+  test: {
+    globals: true,
+    include: ['test/**/*.(spec|test).ts'],
+    exclude: ['node_modules/**'],
+    threads: false,
+
+    coverage: {
+      provider: 'istanbul', // or 'c8'
+    },
+  },
+
+  // plugins: [tsPath()],
+  resolve: {
+    alias: {},
+  },
+  define: {
+    __DEV__: false,
+  },
+});