@quenty/valuebaseutils 5.1.0 → 5.2.0

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.
 
+# [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@5.1.0...@quenty/valuebaseutils@5.2.0) (2022-07-31)
+
+
+### Features
+
+* Add ValueBaseUtils.getValueBaseType(valueBaseClassName) and ValueBaseUtils.getClassNameFromType(luaType) as well as docs ([1e0097d](https://github.com/Quenty/NevermoreEngine/commit/1e0097d22dcdc7051d1bf893c69056807926c301))
+
+
+
+
+
 # [5.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@5.0.0...@quenty/valuebaseutils@5.1.0) (2022-06-21)
 
 **Note:** Version bump only for package @quenty/valuebaseutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valuebaseutils",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.",
   "keywords": [
     "Roblox",
@@ -25,13 +25,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^6.1.0",
-    "@quenty/instanceutils": "^5.1.0",
+    "@quenty/brio": "^6.2.0",
+    "@quenty/instanceutils": "^5.2.0",
     "@quenty/loader": "^5.0.0",
-    "@quenty/promise": "^5.0.0"
+    "@quenty/promise": "^5.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c8732cc5dea767b3ff362db43137e2a16da7bc0d"
+  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
 }

package/src/Shared/ValueBaseUtils.lua

@@ -1,14 +1,76 @@
 --[=[
-	Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.
+	Provides utilities for working with ValueBase objects, like [IntValue] or [ObjectValue] in Roblox.
+
 	@class ValueBaseUtils
 ]=]
 
 local ValueBaseUtils = {}
 
+local TYPE_TO_CLASSNAME_LOOKUP = {
+	["nil"] = "ObjectValue";
+	boolean = "BoolValue";
+	number = "NumberValue";
+	string = "StringValue";
+
+	BrickColor = "BrickColorValue";
+	CFrame = "CFrameValue";
+	Color3 = "Color3Value";
+	Instance = "ObjectValue";
+	Ray = "RayValue";
+	Vector3 = "Vector3Value";
+}
+
+local VALUE_BASE_TYPE_LOOKUP = {
+	BoolValue = "boolean";
+	NumberValue = "number";
+	StringValue = "string";
+	BrickColorValue = "BrickColor";
+	CFrameValue = "CFrame";
+	Color3Value = "Color3";
+	ObjectValue = "Instance";
+	RayValue = "Ray";
+	Vector3Value = "Vector3";
+}
+
+--[=[
+	Returns true if the value is a ValueBase instance
+
+	@param instance Instance
+	@return boolean
+]=]
 function ValueBaseUtils.isValueBase(instance)
-	return typeof(instance) == "Instance" and instance.ClassName:sub(-#"Value") == "Value"
+	return typeof(instance) == "Instance" and instance:IsA("ValueBase")
+end
+
+--[=[
+	Gets the lua type for the given class name
+
+	@param valueBaseClassName string
+	@return string?
+]=]
+function ValueBaseUtils.getValueBaseType(valueBaseClassName)
+	return VALUE_BASE_TYPE_LOOKUP[valueBaseClassName]
 end
 
+--[=[
+	Gets class type for the given lua type
+
+	@param luaType string
+	@return string?
+]=]
+function ValueBaseUtils.getClassNameFromType(luaType)
+	return TYPE_TO_CLASSNAME_LOOKUP[luaType]
+end
+
+--[=[
+	Initializes the value as needed
+
+	@param parent Instance
+	@param instanceType string
+	@param name string
+	@param defaultValue any?
+	@return Instance
+]=]
 function ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValue)
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
@@ -32,6 +94,15 @@ function ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValu
 	end
 end
 
+--[=[
+	Sets the value for the parent
+
+	@param parent Instance
+	@param instanceType string
+	@param name string
+	@param value any
+	@return any
+]=]
 function ValueBaseUtils.setValue(parent, instanceType, name, value)
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
@@ -53,6 +124,15 @@ function ValueBaseUtils.setValue(parent, instanceType, name, value)
 	end
 end
 
+--[=[
+	Gets the value in the children
+
+	@param parent Instance
+	@param instanceType string
+	@param name string
+	@param default any?
+	@return any
+]=]
 function ValueBaseUtils.getValue(parent, instanceType, name, default)
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
@@ -72,6 +152,15 @@ function ValueBaseUtils.getValue(parent, instanceType, name, default)
 	end
 end
 
+--[=[
+	Gets a getter, setter, and initializer for the instance type and name.
+
+	@param instanceType string
+	@param name string
+	@return function
+	@return function
+	@return function
+]=]
 function ValueBaseUtils.createGetSet(instanceType, name)
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
 	assert(type(name) == "string", "Bad argument 'name'")