From bce557cc2dc767628bed6aac87301a1be7c5431b Mon Sep 17 00:00:00 2001 From: rxliuli Date: Tue, 4 Nov 2025 05:03:50 +0800 Subject: init commit --- shared/components/src/utils/throttle.ts | 49 +++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 shared/components/src/utils/throttle.ts (limited to 'shared/components/src/utils/throttle.ts') diff --git a/shared/components/src/utils/throttle.ts b/shared/components/src/utils/throttle.ts new file mode 100644 index 0000000..b5e36bc --- /dev/null +++ b/shared/components/src/utils/throttle.ts @@ -0,0 +1,49 @@ +/* eslint-disable import/prefer-default-export */ +/** + * @name throttle + * @description + * Creates a throttled function that only invokes func at most once per every limit time (ms). + * + * *NOTE: this does not capture or recall all functions that were triggered. + * This will drop function calls that happen during the throttle time* + * @param limit - time to wait between calls in ms + * @example + * Normal event + * event | | | | + * time ---------------- + * callback | | | | + * + * Throttled event [300ms] + * event | | | | + * time ---------------- + * callback | | | + * [300] [300] + */ + +export function throttle( + func: (..._: T) => unknown, + limit: number, +): (..._: T) => void { + let lastTimeoutId; + let lastCallTime: number; + + return function throttled(...args) { + const nextCall = () => { + func.apply(this, args); + lastCallTime = Date.now(); + }; + + if (!lastCallTime) { + nextCall(); + } else { + clearTimeout(lastTimeoutId); + const timeBetweenCalls = Date.now() - lastCallTime; + const waitTime = Math.max(0, limit - timeBetweenCalls); + lastTimeoutId = setTimeout(() => { + if (timeBetweenCalls >= limit) { + nextCall(); + } + }, waitTime); + } + }; +} -- cgit v1.2.3