@quenty/valuebaseutils 4.0.0-canary.236.5597d0a.0 → 4.0.0

package/CHANGELOG.md

@@ -3,7 +3,66 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.4.0...@quenty/valuebaseutils@4.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.8.0...@quenty/valuebaseutils@4.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.7.1...@quenty/valuebaseutils@3.8.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+## [3.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.7.0...@quenty/valuebaseutils@3.7.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.6.0...@quenty/valuebaseutils@3.7.0) (2022-01-07)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.5.2...@quenty/valuebaseutils@3.6.0) (2022-01-03)
+
+
+### Features
+
+* Deprecate RxValueBaseUtils.observe and add RxValueBaseUtils.observeBrio ([2c18d19](https://github.com/Quenty/NevermoreEngine/commit/2c18d19bdd13fbdecefc6f474fad479a45e92559))
+
+
+
+
+
+## [3.5.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.5.1...@quenty/valuebaseutils@3.5.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.5.0...@quenty/valuebaseutils@3.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/valuebaseutils
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valuebaseutils@3.4.0...@quenty/valuebaseutils@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/valuebaseutils
 

package/README.md

@@ -1,10 +1,10 @@
 ## ValueBaseUtils
 <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 @@
 
 Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ValueBaseUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/valuebaseutils --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valuebaseutils",
-  "version": "4.0.0-canary.236.5597d0a.0",
+  "version": "4.0.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": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/instanceutils": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/promise": "4.0.0-canary.236.5597d0a.0"
+    "@quenty/brio": "^5.0.0",
+    "@quenty/instanceutils": "^4.0.0",
+    "@quenty/loader": "^4.0.0",
+    "@quenty/promise": "^4.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Shared/RxValueBaseUtils.lua

@@ -1,6 +1,6 @@
----
--- @module RxValueBaseUtils
--- @author Quenty
+--[=[
+	@class RxValueBaseUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,8 +9,21 @@ local RxBrioUtils = require("RxBrioUtils")
 
 local RxValueBaseUtils = {}
 
+--[=[
+	:::warning
+	This caches the last value seen, and may memory leak.
+	:::
+
+	@param parent Instance
+	@param className string
+	@param name string
+	@return Observable<any>
+	:::
+]=]
 -- TODO: Handle default value/nothing there, instead of memory leaking!
 function RxValueBaseUtils.observe(parent, className, name)
+	warn("[RxValueBaseUtils.observe] - Deprecated since 4.0.0. Use RxValueBaseUtils.observeBrio")
+
 	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
 		:Pipe({
 			RxBrioUtils.switchMap(function(valueObject)
@@ -19,6 +32,29 @@ function RxValueBaseUtils.observe(parent, className, name)
 		})
 end
 
+--[=[
+	Observes a value base underneath a parent (last named child).
+
+	@param parent Instance
+	@param className string
+	@param name string
+	@return Observable<Brio<any>>
+]=]
+function RxValueBaseUtils.observeBrio(parent, className, name)
+	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
+		:Pipe({
+			RxBrioUtils.switchMapBrio(function(valueObject)
+				return RxValueBaseUtils.observeValue(valueObject)
+			end)
+		})
+end
+
+
+--[=[
+	Observables a given value object's value
+	@param valueObject Instance
+	@return Observable<T>
+]=]
 function RxValueBaseUtils.observeValue(valueObject)
 	return RxInstanceUtils.observeProperty(valueObject, "Value")
 end

package/src/Shared/ValueBaseUtils.lua

@@ -1,6 +1,7 @@
---- Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.
--- @module ValueBaseUtils
--- @author Quenty
+--[=[
+	Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.
+	@class ValueBaseUtils
+]=]
 
 local ValueBaseUtils = {}