@quenty/maid 3.4.0 → 3.4.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.
 
+## [3.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/maid@3.4.0...@quenty/maid@3.4.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/maid@3.3.0...@quenty/maid@3.4.0) (2024-10-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/maid",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Easily cleanup event listeners and objects in Roblox",
   "keywords": [
     "Roblox",
@@ -29,5 +29,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "035abfa088c854a73e1c65b350267eaa17669646"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Maid.lua

@@ -1,4 +1,5 @@
---[=[
+--!strict
+--[[
 	Manages the cleaning of events and other things. Useful for
 	encapsulating state and make deconstructors easy.
 
@@ -18,29 +19,46 @@
 	maid:DoCleaning()
 	```
 
+	@ignore
 	@class Maid
-]=]
+]]
 -- luacheck: pop
 
 local Maid = {}
 Maid.ClassName = "Maid"
 
---[=[
+export type MaidTask = (() -> ()) | Instance | thread | Maid | any
+
+export type Maid = typeof(setmetatable(
+	{} :: {
+		Add: <T>(self: Maid, task: T) -> T,
+		GiveTask: (self: Maid, task: MaidTask) -> number,
+		GivePromise: <T>(self: Maid, promise: T) -> T,
+		DoCleaning: (self: Maid) -> (),
+		Destroy: (self: Maid) -> (),
+		_tasks: { [any]: MaidTask },
+		[string | number | { [any]: any } | Instance]: MaidTask?,
+	},
+	Maid
+))
+
+--[[
 	Constructs a new Maid object
 
 	```lua
 	local maid = Maid.new()
 	```
 
+	@ignore
 	@return Maid
-]=]
-function Maid.new()
+]]
+function Maid.new(): Maid
 	return setmetatable({
-		_tasks = {}
-	}, Maid)
+		_tasks = {},
+	}, Maid) :: Maid
 end
 
---[=[
+--[[
 	Returns true if the class is a maid, and false otherwise.
 
 	```lua
@@ -48,14 +66,15 @@ end
 	print(Maid.isMaid(nil)) --> false
 	```
 
+	@ignore
 	@param value any
 	@return boolean
-]=]
-function Maid.isMaid(value)
+]]
+function Maid.isMaid(value: any): boolean
 	return type(value) == "table" and value.ClassName == "Maid"
 end
 
---[=[
+--[[
 	Returns Maid[key] if not part of Maid metatable
 
 	```lua
@@ -67,10 +86,11 @@ end
 	print(maid._current) --> nil
 	```
 
+	@ignore
 	@param index any
 	@return MaidTask
-]=]
-function Maid:__index(index)
+]]
+function Maid.__index(self: Maid, index: any)
 	if Maid[index] then
 		return Maid[index]
 	else
@@ -78,7 +98,7 @@ function Maid:__index(index)
 	end
 end
 
---[=[
+--[[
 	Add a task to clean up. Tasks given to a maid will be cleaned when
 	maid[index] is set to a different value.
 
@@ -94,10 +114,11 @@ end
 	Maid[key] = nil                Removes a named task.
 	```
 
+	@ignore
 	@param index any
 	@param newTask MaidTask
-]=]
-function Maid:__newindex(index, newTask)
+]]
+function Maid.__newindex(self: Maid, index: any, newTask: MaidTask)
 	if Maid[index] ~= nil then
 		error(string.format("Cannot use '%s' as a Maid key", tostring(index)), 2)
 	end
@@ -112,16 +133,15 @@ function Maid:__newindex(index, newTask)
 	tasks[index] = newTask
 
 	if job then
-		local jobType = typeof(job)
-		if jobType == "function" then
-			job()
-		elseif jobType == "table" then
+		if typeof(job) == "function" then
+			(job :: any)()
+		elseif typeof(job) == "table" then
 			if type(job.Destroy) == "function" then
 				job:Destroy()
 			end
-		elseif jobType == "Instance" then
+		elseif typeof(job) == "Instance" then
 			job:Destroy()
-		elseif jobType == "thread" then
+		elseif typeof(job) == "thread" then
 			local cancelled
 			if coroutine.running() ~= job then
 				cancelled = pcall(function()
@@ -134,60 +154,63 @@ function Maid:__newindex(index, newTask)
 					task.cancel(job)
 				end)
 			end
-		elseif jobType == "RBXScriptConnection" then
+		elseif typeof(job) == "RBXScriptConnection" then
 			job:Disconnect()
 		end
 	end
 end
 
---[=[
+--[[
 	Gives a task to the maid for cleanup and returns the resulting value
 
+	@ignore
 	@param task MaidTask -- An item to clean
 	@return MaidTask
-]=]
-function Maid:Add(task)
+]]
+function Maid.Add<T>(self: Maid, task: T): T
 	if not task then
 		error("Task cannot be false or nil", 2)
 	end
 
-	self[#self._tasks+1] = task
+	self[#(self._tasks :: any) + 1] = task
 
-	if type(task) == "table" and (not task.Destroy) then
+	if type(task) == "table" and not task.Destroy then
 		warn("[Maid.Add] - Gave table task without .Destroy\n\n" .. debug.traceback())
 	end
 
 	return task
 end
 
---[=[
+--[[
 	Gives a task to the maid for cleanup, but uses an incremented number as a key.
 
+	@ignore
 	@param task MaidTask -- An item to clean
 	@return number -- taskId
-]=]
-function Maid:GiveTask(task)
+]]
+function Maid.GiveTask(self: Maid, task: MaidTask): number
 	if not task then
 		error("Task cannot be false or nil", 2)
 	end
 
-	local taskId = #self._tasks+1
+	local taskId = #(self._tasks :: any) + 1
 	self[taskId] = task
 
-	if type(task) == "table" and (not task.Destroy) then
+	if type(task) == "table" and not task.Destroy then
 		warn("[Maid.GiveTask] - Gave table task without .Destroy\n\n" .. debug.traceback())
 	end
 
 	return taskId
 end
 
---[=[
+--[[
 	Gives a promise to the maid for clean.
 
+	@ignore
 	@param promise Promise<T>
 	@return Promise<T>
-]=]
-function Maid:GivePromise(promise)
+]]
+function Maid.GivePromise(self: Maid, promise: any): any
 	if not promise:IsPending() then
 		return promise
 	end
@@ -203,7 +226,7 @@ function Maid:GivePromise(promise)
 	return newPromise
 end
 
---[=[
+--[[
 	Cleans up all tasks and removes them as entries from the Maid.
 
 	:::note
@@ -218,12 +241,14 @@ end
 	However, adding tasks while cleaning is not generally a good idea, as if you add a
 	function that adds itself, this will loop indefinitely.
 	:::
-]=]
-function Maid:DoCleaning()
+
+	@ignore
+]]
+function Maid.DoCleaning(self: Maid)
 	local tasks = self._tasks
 
 	-- Disconnect all events first as we know this is safe
-	for index, job in pairs(tasks) do
+	for index, job in tasks do
 		if typeof(job) == "RBXScriptConnection" then
 			tasks[index] = nil
 			job:Disconnect()
@@ -234,14 +259,13 @@ function Maid:DoCleaning()
 	local index, job = next(tasks)
 	while job ~= nil do
 		tasks[index] = nil
-		local jobType = typeof(job)
-		if jobType == "function" then
-			job()
-		elseif jobType == "table" and type(job.Destroy) == "function" then
+		if typeof(job) == "function" then
+			(job :: any)()
+		elseif typeof(job) == "table" and type(job.Destroy) == "function" then
 			job:Destroy()
-		elseif jobType == "Instance" then
+		elseif typeof(job) == "Instance" then
 			job:Destroy()
-		elseif jobType == "thread" then
+		elseif typeof(job) == "thread" then
 			local cancelled
 			if coroutine.running() ~= job then
 				cancelled = pcall(function()
@@ -255,19 +279,20 @@ function Maid:DoCleaning()
 					task.cancel(toCancel)
 				end)
 			end
-		elseif jobType == "RBXScriptConnection" then
+		elseif typeof(job) == "RBXScriptConnection" then
 			job:Disconnect()
 		end
 		index, job = next(tasks)
 	end
 end
 
---[=[
+--[[
 	Alias for [Maid.DoCleaning()](/api/Maid#DoCleaning)
 
+	@ignore
 	@function Destroy
 	@within Maid
-]=]
+]]
 Maid.Destroy = Maid.DoCleaning
 
 return Maid

package/src/Shared/MaidTaskUtils.lua

@@ -8,12 +8,15 @@
 	@type Destructable Instance | { Destroy: function }
 	@within MaidTaskUtils
 ]=]
+export type Destructable = Instance | any
 
 --[=[
 	An object that can be cleaned up
 	@type MaidTask function | thread | Destructable | RBXScriptConnection
 	@within MaidTaskUtils
 ]=]
+export type MaidTask = (() -> ()) | thread | Instance | Destructable | RBXScriptConnection
+
 local MaidTaskUtils = {}
 
 --[=[
@@ -22,7 +25,7 @@ local MaidTaskUtils = {}
 	@param job any
 	@return boolean
 ]=]
-function MaidTaskUtils.isValidTask(job)
+function MaidTaskUtils.isValidTask(job: any): boolean
 	local jobType = typeof(job)
 	return jobType == "function"
 		or jobType == "thread"
@@ -36,17 +39,16 @@ end
 
 	@param job MaidTask -- Task to execute
 ]=]
-function MaidTaskUtils.doTask(job)
-	local jobType = typeof(job)
-	if jobType == "function" then
-		job()
-	elseif jobType == "table" then
+function MaidTaskUtils.doTask(job: MaidTask)
+	if typeof(job) == "function" then
+		(job :: any)()
+	elseif typeof(job) == "table" then
 		if type(job.Destroy) == "function" then
 			job:Destroy()
 		end
-	elseif jobType == "Instance" then
+	elseif typeof(job) == "Instance" then
 		job:Destroy()
-	elseif jobType == "thread" then
+	elseif typeof(job) == "thread" then
 		local cancelled
 		if coroutine.running() ~= job then
 			cancelled = pcall(function()
@@ -59,7 +61,7 @@ function MaidTaskUtils.doTask(job)
 				task.cancel(job)
 			end)
 		end
-	elseif jobType == "RBXScriptConnection" then
+	elseif typeof(job) == "RBXScriptConnection" then
 		job:Disconnect()
 	else
 		error(string.format("[MaidTaskUtils.doTask] - Bad job of type %q", typeof(job)))
@@ -78,7 +80,7 @@ end
 	@param job MaidTask -- Job to delay execution
 	@return () -> () -- function that will execute the job delayed
 ]=]
-function MaidTaskUtils.delayed(time, job)
+function MaidTaskUtils.delayed(time: number, job: MaidTask)
 	assert(type(time) == "number", "Bad time")
 	assert(MaidTaskUtils.isValidTask(job), "Bad job")