Update Immediate.lua

Author: lucasmz-dev

src/ReplicatedStorage/Signal/Immediate.lua

@@ -83,17 +83,20 @@ local function RunHandlerInFreeThread(...)
 	end
 end
 
-function ScriptSignal.new()
+-- Creates a ScriptSignal object
+function ScriptSignal.new(): Class
 	return setmetatable({
 		_active = true,
 		_head = nil
 	}, ScriptSignal)
 end
 
+-- Returns a boolean determining if the ScriptSignal object is usable
 function ScriptSignal:IsActive(): boolean
 	return self._active == true
 end
 
+-- Connects a function to the ScriptSignal object
 function ScriptSignal:Connect(
 	handle: (...any) -> ()
 )
@@ -112,8 +115,8 @@ function ScriptSignal:Connect(
 
 	local node = {
 		_signal = self,
-		_handle = handle,
 		_connection = nil,
+		_handle = handle,
 
 		_next = _head,
 		_prev = nil
@@ -135,6 +138,8 @@ function ScriptSignal:Connect(
 	return connection
 end
 
+-- Connects a function to a ScriptSignal object, but only allows that
+-- connection to run once; any later fires won't trigger anything
 function ScriptSignal:ConnectOnce(
 	handle: (...any) -> ()
 )
@@ -156,6 +161,8 @@ function ScriptSignal:ConnectOnce(
 	end)
 end
 
+-- Yields the current thread until the signal is fired, returns what
+-- it was fired with
 function ScriptSignal:Wait(): (...any)
 	local thread do
 		thread = coroutine.running()
@@ -176,6 +183,7 @@ function ScriptSignal:Wait(): (...any)
 	return coroutine.yield()
 end
 
+-- Fires a ScriptSignal object with the arguments passed through it
 function ScriptSignal:Fire(...)
 	local node = self._head
 	while node ~= nil do
@@ -193,6 +201,8 @@ function ScriptSignal:Fire(...)
 	end
 end
 
+-- Disconnects all connections from a ScriptSignal object
+-- without destroying it and without making it unusable
 function ScriptSignal:DisconnectAll()
 	local node = self._head
 	while node ~= nil do
@@ -202,6 +212,8 @@ function ScriptSignal:DisconnectAll()
 	end
 end
 
+-- Destroys a ScriptSignal object, disconnecting all connections
+-- and making it unusable.
 function ScriptSignal:Destroy()
 	if self._active == false then
 		return
@@ -211,6 +223,8 @@ function ScriptSignal:Destroy()
 	self._active = false
 end
 
+-- Disconnects a connection, any :Fire calls from now on would not
+-- invoke this connection's function
 function ScriptConnection:Disconnect()
 	if self.Connected == false then
 		return
@@ -238,7 +252,7 @@ function ScriptConnection:Disconnect()
 	self._node = nil
 end
 
-export type ScriptSignal = typeof(
+export type Class = typeof(
 	setmetatable({}, ScriptSignal)
 )