@quenty/valueobject 3.4.1-canary.8533eea.0 → 3.5.1

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.4.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.4.0...@quenty/valueobject@3.4.1-canary.8533eea.0) (2021-12-18)
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.5.0...@quenty/valueobject@3.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.4.0...@quenty/valueobject@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/valueobject
 

package/README.md

@@ -1,10 +1,10 @@
 ## ValueObject
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
 
 To work like value objects in Roblox and track a single item with .Changed events. The motivation here is to keep it simple to work with an encapsulated value. Instead of exposing an `IPropertyChanged` interface like C# might do, we instead expose objects with .Changed that are encapsulated within the object in question.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ValueObject">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/valueobject --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valueobject",
-  "version": "3.4.1-canary.8533eea.0",
+  "version": "3.5.1",
   "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.4.1-canary.8533eea.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/rx": "3.4.1-canary.8533eea.0",
-    "@quenty/signal": "2.0.0"
+    "@quenty/brio": "^3.5.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/rx": "^3.5.1",
+    "@quenty/signal": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/ValueObject.lua

@@ -1,6 +1,8 @@
---- To work like value objects in Roblox and track a single item,
--- with `.Changed` events
--- @classmod ValueObject
+--[=[
+	To work like value objects in Roblox and track a single item,
+	with `.Changed` events
+	@class ValueObject
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,18 +12,11 @@ local Maid = require("Maid")
 local ValueObject = {}
 ValueObject.ClassName = "ValueObject"
 
---- The value of the ValueObject
--- @tfield Variant Value
-
---- Event fires when the value's object value change
--- @signal Changed
--- @tparam Variant newValue The new value
--- @tparam Variant oldValue The old value
-
-
---- Constructs a new value object
--- @constructor
--- @treturn ValueObject
+--[=[
+	Constructs a new value object
+	@param baseValue T
+	@return ValueObject
+]=]
 function ValueObject.new(baseValue)
 	local self = {}
 
@@ -35,10 +30,26 @@ function ValueObject.new(baseValue)
 	return setmetatable(self, ValueObject)
 end
 
+--[=[
+	Returns whether the object is a ValueObject class
+	@param value any
+	@return boolean
+]=]
 function ValueObject.isValueObject(value)
 	return type(value) == "table" and getmetatable(value) == ValueObject
 end
 
+--[=[
+	Event fires when the value's object value change
+	@prop Changed Signal<T> -- fires with oldValue, newValue
+	@within ValueObject
+]=]
+
+--[=[
+	The value of the ValueObject
+	@prop Value T
+	@within ValueObject
+]=]
 function ValueObject:__index(index)
 	if index == "Value" then
 		return self._value
@@ -68,7 +79,11 @@ function ValueObject:__newindex(index, value)
 	end
 end
 
---- Forces the value to be nil on cleanup, cleans up the Maid
+--[=[
+	Forces the value to be nil on cleanup, cleans up the Maid
+
+	Does not fire the event since 3.5.0
+]=]
 function ValueObject:Destroy()
 	rawset(self, "_value", nil)
 	self._maid:DoCleaning()

package/src/Shared/ValueObjectUtils.lua

@@ -1,5 +1,7 @@
---- Utils that work with Roblox Value objects (and also ValueObject)
--- @module ValueObjectUtils
+--[=[
+	Utils that work with Roblox Value objects (and also ValueObject)
+	@class ValueObjectUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)