@quenty/throttle 3.2.0 → 3.3.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.3.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/throttle@3.2.1...@quenty/throttle@3.3.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/throttle
+
+
+
+
+
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/throttle@3.2.0...@quenty/throttle@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/throttle
+
+
+
+
+
 # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/throttle@3.1.1...@quenty/throttle@3.2.0) (2021-11-20)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 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

@@ -1,14 +1,21 @@
 ## Throttle
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
   </a>
 </div>
 
-A throttle implementation for Roblox
+A throttle implementation for Roblox
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/throttle">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/throttle --save
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/throttle",
-  "version": "3.2.0",
+  "version": "3.3.0-canary.241.a4e8214.0",
   "description": "Adds the throttle function to Roblox",
   "keywords": [
     "Roblox",
@@ -26,7 +26,7 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0"
   },
   "devDependencies": {
     "@quenty/loader": "file:../loader"
@@ -34,5 +34,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "87ab1435a59a05e7dd745db1dfcec26116d1d71d"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Shared/ThrottledFunction.lua

@@ -1,5 +1,7 @@
---- Throttles execution of a functon. Does both leading, and following
--- @classmod ThrottledFunction
+--[=[
+	Throttles execution of a functon. Does both leading, and following
+	@class ThrottledFunction
+]=]
 
 local ThrottledFunction = {}
 ThrottledFunction.ClassName = "ThrottledFunction"

package/src/Shared/throttle.lua

@@ -1,15 +1,23 @@
---- debounce a existing function by timeout
--- @module debounce
+--[=[
+	Debounce a existing function by timeout
+
+	@class throttle
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
 local ThrottledFunction = require("ThrottledFunction")
 
---- Provides a debounce function call on an operation
--- @tparam number timeout
--- @tparam function func
--- @param throttleConfig = { leading = true; trailing = true; }
--- @treturn function
+--[=[
+	Provides a debounce function call on an operation.
+
+	@function throttle
+	@within throttle
+	@param timeoutInSeconds number
+	@param func function
+	@param throttleConfig? { leading = true; trailing = true; }
+	@return function
+]=]
 local function throttle(timeoutInSeconds, func, throttleConfig)
 	assert(type(timeoutInSeconds) == "number", "timeoutInSeconds is not a number")
 	assert(type(func) == "function", "func is not a function")