@quenty/signal 7.11.1 → 7.11.2

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.
 
+## [7.11.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/signal@7.11.1...@quenty/signal@7.11.2) (2025-12-29)
+
+
+### Bug Fixes
+
+* Update typing to be more accurate ([e4c3d05](https://github.com/Quenty/NevermoreEngine/commit/e4c3d05a0aa9f45a37cbfa372c5e0d8a748c9323))
+
+
+
+
+
 ## [7.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/signal@7.11.0...@quenty/signal@7.11.1) (2025-08-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/signal",
-  "version": "7.11.1",
+  "version": "7.11.2",
   "description": "A simple signal implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -32,5 +32,5 @@
   "dependencies": {
     "@quenty/loader": "^10.9.0"
   },
-  "gitHead": "847e9e65e518392c1e2f30669ee2589ed3d7e870"
+  "gitHead": "e4614dfea3bf2580ec2b10552c311b273ed1387c"
 }

package/src/Shared/Signal.lua

@@ -48,7 +48,11 @@ local require = require(script.Parent.loader).load(script)
 
 local EventHandlerUtils = require("EventHandlerUtils")
 
--- Connection class
+--[=[
+	A connection to a signal.
+
+	@class Connection
+]=]
 local Connection = {}
 Connection.ClassName = "Connection"
 Connection.__index = Connection
@@ -64,6 +68,13 @@ export type Connection<T...> = typeof(setmetatable(
 	{} :: typeof({ __index = Connection })
 ))
 
+--[=[
+	Constructs a new connection object. Not useful directly, use Signal:Connect instead.
+
+	@param signal Signal<T...> -- The signal this connection is connected to
+	@param fn (... T) -> () -- The function handler for this connection
+	@return Connection
+]=]
 function Connection.new<T...>(signal: Signal<T...>, fn: SignalHandler<T...>): Connection<T...>
 	return setmetatable({
 		-- selene: allow(incorrect_standard_library_use)
@@ -73,10 +84,22 @@ function Connection.new<T...>(signal: Signal<T...>, fn: SignalHandler<T...>): Co
 	}, Connection) :: any
 end
 
+--[=[
+	Returns whether the connection is still connected.
+
+	@within Connection
+	@return boolean
+]=]
 function Connection.IsConnected<T...>(self: Connection<T...>): boolean
 	return rawget(self :: any, "_signal") ~= nil
 end
 
+--[=[
+	Disconnects the connection from the signal.
+
+	@within Connection
+	@return ()
+]=]
 function Connection.Disconnect<T...>(self: Connection<T...>)
 	local signal = rawget(self :: any, "_signal")
 	if not signal then
@@ -109,6 +132,12 @@ function Connection.Disconnect<T...>(self: Connection<T...>)
 	table.clear(self :: any)
 end
 
+--[=[
+	Alias for [Disconnect]
+
+	@function Destroy
+	@within Connection
+]=]
 Connection.Destroy = Connection.Disconnect
 
 -- Make signal strict
@@ -170,9 +199,14 @@ function Signal.Connect<T...>(self: Signal<T...>, fn: SignalHandler<T...>): Conn
 	return connection
 end
 
-function Signal:GetConnectionCount()
+--[=[
+	Returns the number of connected handlers to the signal.
+
+	@return number
+]=]
+function Signal.GetConnectionCount<T...>(self: Signal<T...>): number
 	local n = 0
-	local prev = self._handlerListHead
+	local prev: any = self._handlerListHead
 	while prev do
 		n += 1
 		prev = rawget(prev, "_next")