@quenty/attributeutils 4.0.0 → 4.0.1-canary.238.2c4d310.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@4.0.0...@quenty/attributeutils@4.0.1-canary.238.2c4d310.0) (2021-12-29)
+
+**Note:** Version bump only for package @quenty/attributeutils
+
+
+
+
+
 # [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@3.6.0...@quenty/attributeutils@4.0.0) (2021-12-22)
 
 

package/README.md

@@ -1,10 +1,10 @@
 ## AttributeUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
+  <a href="http://quenty.github.io/NevermoreEngine/">
     <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
   </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" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/attributeutils",
-  "version": "4.0.0",
+  "version": "4.0.1-canary.238.2c4d310.0",
   "description": "Provides utility functions to work with attributes in Roblox",
   "keywords": [
     "Roblox",
@@ -25,12 +25,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/maid": "^2.0.1",
-    "@quenty/rx": "^3.5.0"
+    "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
+    "@quenty/maid": "2.0.2-canary.238.2c4d310.0",
+    "@quenty/rx": "3.5.1-canary.238.2c4d310.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3a3d03785e31c5b53d27d1fff519a53c695fbc19"
+  "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
 }

package/src/Shared/AttributeUtils.lua

@@ -1,6 +1,7 @@
---- Provides utility functions to work with attributes in Roblox
--- @module AttributeUtils
--- @author Quenty
+--[=[
+	Provides utility functions to work with attributes in Roblox
+	@class AttributeUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,6 +11,15 @@ local Maid = require("Maid")
 
 local AttributeUtils = {}
 
+--[=[
+	Whenever the attribute is true, the binder will be bound, and when the
+	binder is bound, the attribute will be true.
+
+	@param instance Instance
+	@param attributeName string
+	@param binder Binder<T>
+	@return Maid
+]=]
 function AttributeUtils.bindToBinder(instance, attributeName, binder)
 	assert(binder, "Bad binder")
 	assert(typeof(instance) == "Instance", "Bad instance")

package/src/Shared/AttributeValue.lua

@@ -1,11 +1,35 @@
----
--- @classmod AttributeValue
--- @author Quenty
+--[=[
+	Allows access to an attribute like a ValueObject.
+
+	```lua
+	local attributeValue = AttributeValue.new(workspace, "Version", "1.0.0")
+	print(attributeValue.Value) --> 1.0.0
+	print(workspace:GetAttribute("version")) --> 1.0.0
+
+	attributeValue.Changed:Connect(function()
+		print(attributeValue.Value)
+	end)
+
+	workspace:SetAttribute("1.1.0") --> 1.1.0
+	attributeValue.Value = "1.2.0" --> 1.2.0
+	```
+
+	@class AttributeValue
+]=]
 
 local AttributeValue = {}
 AttributeValue.ClassName = "AttributeValue"
 AttributeValue.__index = AttributeValue
 
+--[=[
+	Constructs a new AttributeValue. If a defaultValue that is not nil
+	is defined, then this value will be set on the Roblox object.
+
+	@param object Instance
+	@param attributeName string
+	@param defaultValue T?
+	@return AttributeValue<T>
+]=]
 function AttributeValue.new(object, attributeName, defaultValue)
 	assert(typeof(object) == "Instance", "Bad object")
 	assert(type(attributeName) == "string", "Bad attributeName")
@@ -23,6 +47,19 @@ function AttributeValue.new(object, attributeName, defaultValue)
 	return setmetatable(self, AttributeValue)
 end
 
+--[=[
+	The current property of the Attribute. Can be assigned to to write
+	the attribute.
+	@prop Value T
+	@within AttributeValue
+]=]
+
+--[=[
+	Signal that fires when the attribute changes
+	@readonly
+	@prop Changed Signal<()>
+	@within AttributeValue
+]=]
 function AttributeValue:__index(index)
 	if index == "Value" then
 		local result = self._object:GetAttribute(rawget(self, "_attributeName"))

package/src/Shared/RxAttributeUtils.lua

@@ -1,6 +1,7 @@
----
--- @module RxAttributeUtils
--- @author Quenty
+--[=[
+	Utility functions involving attributes.
+	@class RxAttributeUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,6 +10,13 @@ local Maid = require("Maid")
 
 local RxAttributeUtils = {}
 
+--[=[
+	Observes an attribute on an instance.
+	@param instance Instance
+	@param attributeName string
+	@param defaultValue any?
+	@return Observable<any>
+]=]
 function RxAttributeUtils.observeAttribute(instance, attributeName, defaultValue)
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(attributeName) == "string", "Bad attributeName")