@quenty/throttle 10.9.0 → 10.9.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.9.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/throttle@10.9.0...@quenty/throttle@10.9.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [10.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/throttle@10.8.1...@quenty/throttle@10.9.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/throttle

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/throttle",
-  "version": "10.9.0",
+  "version": "10.9.1",
   "description": "Adds the throttle function to Roblox",
   "keywords": [
     "Roblox",
@@ -26,7 +26,8 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0"
+    "@quenty/loader": "^10.8.1",
+    "@quenty/typeutils": "^1.0.1"
   },
   "devDependencies": {
     "@quenty/loader": "file:../loader"
@@ -34,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/ThrottledFunction.lua

@@ -3,11 +3,17 @@
 	@class ThrottledFunction
 ]=]
 
+export type ThrottleConfig = {
+	leading: boolean?,
+	trailing: boolean?,
+	leadingFirstTimeOnly: boolean?,
+}
+
 local ThrottledFunction = {}
 ThrottledFunction.ClassName = "ThrottledFunction"
 ThrottledFunction.__index = ThrottledFunction
 
-function ThrottledFunction.new(timeoutInSeconds, func, config)
+function ThrottledFunction.new(timeoutInSeconds: number, func, config: ThrottleConfig)
 	local self = setmetatable({}, ThrottledFunction)
 
 	self._nextCallTimeStamp = 0
@@ -24,7 +30,7 @@ function ThrottledFunction.new(timeoutInSeconds, func, config)
 	return self
 end
 
-function ThrottledFunction:Call(...)
+function ThrottledFunction:Call<T...>(...: T...)
 	if self._trailingValue then
 		-- Update the next value to be dispatched
 		self._trailingValue = table.pack(...)
@@ -72,14 +78,14 @@ function ThrottledFunction:_dispatch()
 	end
 end
 
-function ThrottledFunction:_configureOrError(throttleConfig)
+function ThrottledFunction:_configureOrError(throttleConfig: ThrottleConfig)
 	if throttleConfig == nil then
 		return
 	end
 
 	assert(type(throttleConfig) == "table", "Bad throttleConfig")
 
-	for key, value in pairs(throttleConfig) do
+	for key, value in throttleConfig do
 		assert(type(value) == "boolean", "Bad throttleConfig entry")
 
 		if key == "leading" then

package/src/Shared/throttle.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Debounce a existing function by timeout
 
@@ -7,6 +8,9 @@
 local require = require(script.Parent.loader).load(script)
 
 local ThrottledFunction = require("ThrottledFunction")
+local TypeUtils = require("TypeUtils")
+
+export type ThrottleConfig = ThrottledFunction.ThrottleConfig
 
 --[=[
 	Provides a debounce function call on an operation.
@@ -18,14 +22,14 @@ local ThrottledFunction = require("ThrottledFunction")
 	@param throttleConfig? { leading = true; trailing = true; }
 	@return function
 ]=]
-local function throttle(timeoutInSeconds, func, throttleConfig)
+local function throttle<T...>(timeoutInSeconds: number, func: (T...) -> ...any, throttleConfig: ThrottledFunction.ThrottleConfig): (T...) -> ()
 	assert(type(timeoutInSeconds) == "number", "timeoutInSeconds is not a number")
 	assert(type(func) == "function", "func is not a function")
 
 	local throttled = ThrottledFunction.new(timeoutInSeconds, func, throttleConfig)
 
-	return function(...)
-		throttled:Call(...)
+	return function(...: T...)
+		throttled:Call(TypeUtils.anyValue(...))
 	end
 end