@quenty/valueobject 3.6.0 → 3.6.1-canary.913a974.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.
 
+## [3.6.1-canary.913a974.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.6.0...@quenty/valueobject@3.6.1-canary.913a974.0) (2022-01-07)
+
+
+### Features
+
+* Add ValueObject:Observe() and StateStack:Observe() ([c10f200](https://github.com/Quenty/NevermoreEngine/commit/c10f2008508f5b44fe61c91081142ddf67ee9605))
+
+
+
+
+
 # [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.5.2...@quenty/valueobject@3.6.0) (2022-01-03)
 
 **Note:** Version bump only for package @quenty/valueobject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valueobject",
-  "version": "3.6.0",
+  "version": "3.6.1-canary.913a974.0",
   "description": "To work like value objects in Roblox and track a single item with .Changed events",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^3.6.0",
-    "@quenty/loader": "^3.2.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/rx": "^3.6.0",
-    "@quenty/signal": "^2.1.0"
+    "@quenty/brio": "3.6.1-canary.913a974.0",
+    "@quenty/loader": "3.2.1-canary.913a974.0",
+    "@quenty/maid": "2.0.2",
+    "@quenty/rx": "3.6.1-canary.913a974.0",
+    "@quenty/signal": "2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d910da8f5c7e9a55a8bf76d8efbe5632713dd0fe"
+  "gitHead": "913a974e69304d8dc5aa805f2db4638a206fe89e"
 }

package/src/Shared/ValueObject.lua

@@ -8,6 +8,7 @@ local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 local Maid = require("Maid")
+local Observable = require("Observable")
 
 local ValueObject = {}
 ValueObject.ClassName = "ValueObject"
@@ -24,6 +25,11 @@ function ValueObject.new(baseValue)
 
 	self._maid = Maid.new()
 
+--[=[
+	Event fires when the value's object value change
+	@prop Changed Signal<T> -- fires with oldValue, newValue
+	@within ValueObject
+]=]
 	self.Changed = Signal.new() -- :Fire(newValue, oldValue, maid)
 	self._maid:GiveTask(self.Changed)
 
@@ -40,10 +46,30 @@ function ValueObject.isValueObject(value)
 end
 
 --[=[
-	Event fires when the value's object value change
-	@prop Changed Signal<T> -- fires with oldValue, newValue
-	@within ValueObject
+	Observes the current value of the ValueObject
+	@return Observable<T>
 ]=]
+function ValueObject:Observe()
+	return Observable.new(function(sub)
+		if not self.Destroy then
+			warn("[ValueObject.observeValue] - Connecting to dead ValueObject")
+			-- No firing, we're dead
+			sub:Complete()
+			return
+		end
+
+		local maid = Maid.new()
+
+		maid:GiveTask(self.Changed:Connect(function()
+			sub:Fire(self.Value)
+		end))
+
+		sub:Fire(self.Value)
+
+		return maid
+	end)
+
+end
 
 --[=[
 	The value of the ValueObject

package/src/Shared/ValueObjectUtils.lua

@@ -12,6 +12,12 @@ local ValueObject = require("ValueObject")
 
 local ValueObjectUtils = {}
 
+--[=[
+	Syncs the value from `from` to `to`.
+	@param from ValueObject<T>
+	@param to ValueObject<T>
+	@return MaidTask
+]=]
 function ValueObjectUtils.syncValue(from, to)
 	local maid = Maid.new()
 	to.Value = from.Value
@@ -23,6 +29,11 @@ function ValueObjectUtils.syncValue(from, to)
 	return maid
 end
 
+--[=[
+	Observes the current value of the ValueObject
+	@param valueObject ValueObject<T>
+	@return Observable<T>
+]=]
 function ValueObjectUtils.observeValue(valueObject)
 	assert(ValueObject.isValueObject(valueObject), "Bad valueObject")
 
@@ -30,6 +41,7 @@ function ValueObjectUtils.observeValue(valueObject)
 		if not valueObject.Destroy then
 			warn("[ValueObjectUtils.observeValue] - Connecting to dead ValueObject")
 			-- No firing, we're dead
+			sub:Complete()
 			return
 		end
 
@@ -45,6 +57,11 @@ function ValueObjectUtils.observeValue(valueObject)
 	end)
 end
 
+--[=[
+	Observes the current value of the ValueObject
+	@param valueObject ValueObject<T>
+	@return Observable<Brio<T>>
+]=]
 function ValueObjectUtils.observeValueBrio(valueObject)
 	assert(valueObject, "Bad valueObject")