@quenty/boundlinkutils 5.0.0-canary.236.5597d0a.0 → 5.1.0

package/CHANGELOG.md

@@ -3,7 +3,71 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [5.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.4.0...@quenty/boundlinkutils@5.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [5.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@5.0.0...@quenty/boundlinkutils@5.1.0) (2022-03-10)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+# [5.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.8.0...@quenty/boundlinkutils@5.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+# [4.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.7.1...@quenty/boundlinkutils@4.8.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+## [4.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.7.0...@quenty/boundlinkutils@4.7.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+# [4.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.6.0...@quenty/boundlinkutils@4.7.0) (2022-01-07)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+# [4.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.5.2...@quenty/boundlinkutils@4.6.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+## [4.5.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.5.1...@quenty/boundlinkutils@4.5.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+## [4.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.5.0...@quenty/boundlinkutils@4.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/boundlinkutils
+
+
+
+
+
+# [4.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/boundlinkutils@4.4.0...@quenty/boundlinkutils@4.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/boundlinkutils
 

package/README.md

@@ -1,10 +1,10 @@
 ## BoundLinkUtils
 <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,53 +13,9 @@
 
 Utility functions involving binders and links
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BoundLinkCollection">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/boundlinkutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-## BoundLinkCollection API
-
-### `BoundLinkCollection.new(binder, linkName, parent)`
-Constructs a new version of the collection
-
-### `BoundLinkCollection:GetClasses()`
-Gets all the classes
-
-### `BoundLinkCollection:HasClass(class)`
-Returns whether or not the class is in the collection
-
-### `BoundLinkCollection:TrackParent(parent)`
-Tracks parent in collection
-
-### `BoundLinkCollection:Destroy()`
-Cleans up collection
-
-## promiseBoundLinkedClass API
-
-### `promiseBoundLinkedClass(binder, objValue)`
-
-```lua
-local promiseBoundLinkedClass = require("promiseBoundLinkedClass")
-
-promiseBoundLinkedClass(myBinder, myObjectValue):Then(function(boundClass)
-    print(boundClass)
-end)
-```
-
-## BoundLinkUtils API
-
-### `BoundLinkUtils.getLinkClass(binder, linkName, from)`
-Returns the linked class
-
-### `BoundLinkUtils.getLinkClasses(binder, linkName, from)`
-Returns a link of linked classes
-
-### `BoundLinkUtils.getClassesForLinkValues(binders, linkName, from)`
-Returns all classes for all binders, in a list
-
-### `BoundLinkUtils.callMethodOnLinkedClasses(binders, linkName, from, methodName, args)`
-Calls a method for each linked class for each binder, given the method name and args
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/boundlinkutils",
-  "version": "5.0.0-canary.236.5597d0a.0",
+  "version": "5.1.0",
   "description": "Utility functions involving binders and links",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/binder": "5.0.0-canary.236.5597d0a.0",
-    "@quenty/linkutils": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/promise": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/signal": "2.0.0"
+    "@quenty/binder": "^5.1.0",
+    "@quenty/linkutils": "^4.1.0",
+    "@quenty/loader": "^4.0.0",
+    "@quenty/maid": "^2.2.0",
+    "@quenty/promise": "^4.1.0",
+    "@quenty/signal": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "0797de955876b050fb24875de0423453e268b2ce"
 }

package/src/Shared/BoundLinkCollection.lua

@@ -1,6 +1,9 @@
---- Handles searching for bound objects following links (object values) under a parent
--- with a specific name.
--- @classmod BoundLinkCollection
+--[=[
+	Handles searching for bound objects following links (object values) under a parent
+	with a specific name.
+
+	@class BoundLinkCollection
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Shared/BoundLinkUtils.lua

@@ -1,6 +1,7 @@
---- Utility functions involving binders and links
--- @module BoundLinkUtils
--- @author Quenty
+--[=[
+	Utility functions involving binders and links
+	@class BoundLinkUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Shared/promiseBoundLinkedClass.lua

@@ -1,5 +1,9 @@
----
--- @function promiseBoundLinkedClass
+--[=[
+	Promise that returns an objectValue's value that has a bound
+	value to it.
+
+	@class promiseBoundLinkedClass
+]=]
 
 local require = require(script.Parent.loader).load(script)