Merge pull request #6 from howmanysmall/v2.2.1

updated to v2.2.1

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
 	"Lua.runtime.version": "Luau",
-	"rojo.buildOutputPath": "enumerator"
+	"rojo.buildOutputPath": "enumerator",
+	"stylua.styluaPath": "C:/Path/stylua2Roact.exe",
 }

rotriever.toml

@@ -1,6 +1,6 @@
 [package]
 name = "howmanysmall/enumerator"
-version = "2.2.0"
+version = "2.2.1"
 author = "howmanysmall"
 dependencies_root = "./src/enumerator/"
 content_root = "./src/enumerator"

src/enumerator/init.lua

@@ -43,10 +43,12 @@ local function lockTable(tab, name)
 	})
 end
 
+--t:union<t:array<t:string>, t:keys<t:string>>
+
 --[[**
 	Creates a new enumeration.
 	@param [t:string] enumName The unique name of the enumeration.
-	@param [t:union<t:array<t:string>, t:keys<t:string>>] enumValues The values of the enumeration.
+	@param [t:{string}|{string:any}] enumValues The values of the enumeration.
 	@returns [t:userdata] a new enumeration
 **--]]
 local function enumerator(enumName, enumValues)
@@ -57,10 +59,20 @@ local function enumerator(enumName, enumValues)
 	local rawValues = {}
 	local totalEnums = 0
 
+	--[[**
+		Returns an `EnumerationValue` from the calling `Enumeration` or `nil` if the raw value does not exist.
+		@param [t:any] rawValue The raw value of the enum.
+		@returns [t:EnumerationValue?] The `EnumerationValue` if it was found.
+	**--]]
 	function internal.fromRawValue(rawValue)
 		return rawValues[rawValue]
 	end
 
+	--[[**
+		Returns `true` only if the provided value is an `EnumerationValue` that is a member of the calling `Enumeration`.
+		@param [t:any] value The value to check for.
+		@returns [t:boolean] True iff it is an `EnumerationValue`.
+	**--]]
 	function internal.isEnumValue(value)
 		if typeof(value) ~= "userdata" then
 			return false
@@ -78,7 +90,7 @@ local function enumerator(enumName, enumValues)
 	--[[**
 		This function will cast values to the appropriate enumerator. This behaves like a type checker from t, except it returns the value if it was found.
 		@param [t:any] value The value you want to cast.
-		@returns [t:tuple<t:union<t:literal<false>, enumerator>, t:optional<t:string>>] Either returns the appropriate enumeration if found or false and an error message if it couldn't find it.
+		@returns [t:false|enumerator,string?] Either returns the appropriate enumeration if found or false and an error message if it couldn't find it.
 	**--]]
 	function internal.cast(value)
 		if internal.isEnumValue(value) then

testez-companion.toml

@@ -0,0 +1,2 @@
+roots = ["ReplicatedStorage"]
+extraOptions = {}