@quenty/propertyvalue 7.17.3 → 7.17.4-canary.11a5dcf.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.
 
+## [7.17.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/propertyvalue@7.17.3...@quenty/propertyvalue@7.17.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [7.17.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/propertyvalue@7.17.2...@quenty/propertyvalue@7.17.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/propertyvalue

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/propertyvalue",
-  "version": "7.17.3",
+  "version": "7.17.4-canary.11a5dcf.0",
   "description": "Property value for Roblox instances",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/instanceutils": "^13.17.3",
-    "@quenty/loader": "^10.8.3"
+    "@quenty/instanceutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/PropertyValue.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Proxies a property in Roblox
 
@@ -6,14 +7,47 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local Brio = require("Brio")
+local Observable = require("Observable")
+local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
-local _Observable = require("Observable")
 
 local PropertyValue = {}
 PropertyValue.ClassName = "PropertyValue"
 PropertyValue.__index = PropertyValue
 
-function PropertyValue.new(instance: Instance, propertyName: string)
+export type PropertyValue<T> = typeof(setmetatable(
+	{} :: {
+		--[=[
+			The value of the property
+
+			@prop Value T
+			@within PropertyValue
+		]=]
+		Value: T,
+
+		--[=[
+			The signal that fires when the property changes
+
+			@prop Changed RBXScriptSignal
+			@within PropertyValue
+		]=]
+		Changed: RBXScriptSignal<T>,
+
+		_obj: Instance,
+		_propertyName: string,
+	},
+	{} :: typeof({ __index = PropertyValue })
+))
+
+--[=[
+	Creates a new PropertyValue
+
+	@param instance Instance
+	@param propertyName string
+	@return PropertyValue
+]=]
+function PropertyValue.new<T>(instance: Instance, propertyName: string): PropertyValue<T>
 	assert(typeof(instance) == "Instance", "Bad argument 'instance'")
 	assert(type(propertyName) == "string", "Bad argument 'propertyName'")
 
@@ -22,20 +56,33 @@ function PropertyValue.new(instance: Instance, propertyName: string)
 	self._obj = instance
 	self._propertyName = propertyName
 
-	return setmetatable(self, PropertyValue)
+	return setmetatable(self :: any, PropertyValue)
 end
 
-function PropertyValue:ObserveBrio(condition)
+--[=[
+	Observes the property of the object.
+
+	@return Observable<Brio<T>>
+]=]
+function PropertyValue.ObserveBrio<T>(
+	self: PropertyValue<T>,
+	condition: Rx.Predicate<T>?
+): Observable.Observable<Brio.Brio<T>>
 	return RxInstanceUtils.observePropertyBrio(self._obj, self._propertyName, condition)
 end
 
-function PropertyValue:Observe(): _Observable.Observable<unknown>
+--[=[
+	Observes the property of the object.
+
+	@return Observable<any>
+]=]
+function PropertyValue.Observe<T>(self: PropertyValue<T>): Observable.Observable<any>
 	return RxInstanceUtils.observeProperty(self._obj, self._propertyName)
 end
 
-function PropertyValue:__index(index)
+(PropertyValue :: any).__index = function<T>(self: PropertyValue<T>, index)
 	if index == "Value" then
-		return self._obj[self._propertyName]
+		return (self._obj :: any)[self._propertyName]
 	elseif index == "Changed" then
 		return self._obj:GetPropertyChangedSignal(self._propertyName)
 	elseif PropertyValue[index] or index == "_obj" then
@@ -45,9 +92,11 @@ function PropertyValue:__index(index)
 	end
 end
 
-function PropertyValue:__newindex(index, value)
+function PropertyValue.__newindex<T>(self: PropertyValue<T>, index, value)
 	if index == "Value" then
-		self._obj[self._propertyName] = value
+		(self._obj :: any)[self._propertyName] = value
+	elseif PropertyValue[index] then
+		error(string.format("%q is not writable", tostring(index)))
 	else
 		error(string.format("%q is not a member of PropertyValue", tostring(index)))
 	end