@quenty/attributeutils 8.8.0 → 8.9.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.
 
+# [8.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@8.8.0...@quenty/attributeutils@8.9.0) (2023-03-31)
+
+
+### Features
+
+* Add AttributeUtils.promiseAttribute(instance, attributeName, predicate, cancelToken) ([cf98166](https://github.com/Quenty/NevermoreEngine/commit/cf98166007c7dd2b79946701cd17fb7f89390bae))
+
+
+
+
+
 # [8.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@8.7.0...@quenty/attributeutils@8.8.0) (2023-03-05)
 
 **Note:** Version bump only for package @quenty/attributeutils

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/attributeutils",
-  "version": "8.8.0",
+  "version": "8.9.0",
   "description": "Provides utility functions to work with attributes in Roblox",
   "keywords": [
     "Roblox",
@@ -25,14 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^8.7.0",
+    "@quenty/brio": "^8.8.0",
+    "@quenty/canceltoken": "^6.4.0",
     "@quenty/loader": "^6.2.0",
     "@quenty/maid": "^2.5.0",
-    "@quenty/rx": "^7.7.0",
+    "@quenty/promise": "^6.4.0",
+    "@quenty/rx": "^7.8.0",
     "@quenty/symbol": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e62b5eac2e5d9084ab9083f128452dd2d98b6f1a"
+  "gitHead": "2a1c35a8d2e90b291a83a6e2def0ec69f3f24837"
 }

package/src/Shared/AttributeUtils.lua

@@ -8,6 +8,12 @@ local require = require(script.Parent.loader).load(script)
 local RunService = game:GetService("RunService")
 
 local Maid = require("Maid")
+local Promise = require("Promise")
+local CancelToken = require("CancelToken")
+
+local DEFAULT_PREDICATE = function(value)
+	return value ~= nil
+end
 
 local AttributeUtils = {}
 
@@ -45,6 +51,54 @@ function AttributeUtils.isValidAttributeType(valueType)
 	return VALID_ATTRIBUTE_TYPES[valueType] == true
 end
 
+--[=[
+	Promises attribute value fits predicate
+
+	@param instance Instance
+	@param attributeName string
+	@param predicate function | nil
+	@param cancelToken CancelToken
+	@return Promise<any>
+]=]
+function AttributeUtils.promiseAttribute(instance, attributeName, predicate, cancelToken)
+	assert(typeof(instance) == "Instance", "Bad instance")
+	assert(type(attributeName) == "string", "Bad attributeName")
+	assert(CancelToken.isCancelToken(cancelToken) or cancelToken == nil, "Bad cancelToken")
+
+	predicate = predicate or DEFAULT_PREDICATE
+
+	do
+		local attributeValue = instance:GetAttribute(attributeName)
+		if predicate(attributeValue) then
+			return Promise.resolved(attributeValue)
+		end
+	end
+
+	local promise = Promise.new()
+	local maid = Maid.new()
+	maid:GiveTask(promise)
+
+	if cancelToken then
+		maid:GiveTask(cancelToken.Cancelled:Connect(function()
+			promise:Reject()
+		end))
+	end
+
+	maid:GiveTask(instance:GetAttributeChangedSignal(attributeName):Connect(function()
+		local attributeValue = instance:GetAttribute(attributeName)
+		if predicate(attributeValue) then
+			promise:Resolve(attributeValue)
+		end
+	end))
+
+	promise:Finally(function()
+		maid:DoCleaning()
+	end)
+
+	return promise
+end
+
+
 --[=[
 	Whenever the attribute is true, the binder will be bound, and when the
 	binder is bound, the attribute will be true.