@quenty/statestack 3.1.2 → 3.2.1-canary.238.f89c386.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.2.1-canary.238.f89c386.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/statestack@3.2.0...@quenty/statestack@3.2.1-canary.238.f89c386.0) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/statestack
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/statestack@3.1.2...@quenty/statestack@3.2.0) (2021-11-20)
+
+
+### Bug Fixes
+
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
+
+
+
+
+
 ## [3.1.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/statestack@3.1.1...@quenty/statestack@3.1.2) (2021-10-30)
 
 **Note:** Version bump only for package @quenty/statestack

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 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/README.md

@@ -1,10 +1,10 @@
 ## StateStack
 <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 @@
 
 Stack of values that allows multiple systems to enable or disable a state
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/StateStack">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/statestack --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/statestack",
-  "version": "3.1.2",
+  "version": "3.2.1-canary.238.f89c386.0",
   "description": "Stack of values that allows multiple systems to enable or disable a state",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.1.2",
-    "@quenty/loader": "^3.1.1"
+    "@quenty/baseobject": "3.2.1-canary.238.f89c386.0",
+    "@quenty/loader": "3.1.2-canary.238.f89c386.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9cd4223c7fda7c852db9743ef844baa19cacb13"
+  "gitHead": "f89c3863db94c96adc936ea31a49e0c770756dd0"
 }

package/src/Shared/StateStack.lua

@@ -1,6 +1,25 @@
---- Stack of values that allows multiple systems to enable or disable a state
--- @classmod StateStack
--- @author Quenty
+--[=[
+	Stack of values that allows multiple systems to enable or disable a state.
+
+	```lua
+	local disabledStack = StateStack.new()
+	print(disabledStack:GetState()) --> false
+
+	disabledStack.Changed:Connect(function()
+		print("From changed event we have state: ", disabledStack:GetState())
+	end)
+
+	local cancel = disabledStack:PushState() --> From changed event we have state: true
+	print(disabledStack:GetState()) --> true
+
+	cancel()  --> From changed event we have state: true
+	print(disabledStack:GetState()) --> false
+
+	disabledStack:Destroy()
+	```
+
+	@class StateStack
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,6 +29,10 @@ local StateStack = setmetatable({}, BaseObject)
 StateStack.ClassName = "StateStack"
 StateStack.__index = StateStack
 
+--[=[
+	Constructs a new StateStack.
+	@return StateStack
+]=]
 function StateStack.new()
 	local self = setmetatable(BaseObject.new(), StateStack)
 
@@ -19,15 +42,28 @@ function StateStack.new()
 
 	self._stateStack = {}
 
-	self.Changed = self._state.Changed -- :Fire(newState)
+--[=[
+	Fires with the new state
+	@prop Changed Signal<boolean>
+	@within StateStack
+]=]
+	self.Changed = self._state.Changed
 
 	return self
 end
 
+--[=[
+	Gets the current state
+	@return boolean
+]=]
 function StateStack:GetState()
 	return self._state.Value
 end
 
+--[=[
+	Pushes the current state onto the stack
+	@return function -- Cleanup function to invoke
+]=]
 function StateStack:PushState()
 	local data = {}
 	table.insert(self._stateStack, data)
@@ -55,4 +91,14 @@ function StateStack:_updateState()
 	self._state.Value = next(self._stateStack) ~= nil
 end
 
+--[=[
+	Cleans up the StateStack and sets the metatable to nil.
+
+	:::tip
+	Be sure to call this to clean up the state stack!
+	:::
+	@method Destroy
+	@within StateStack
+]=]
+
 return StateStack

package/src/node_modules.project.json

@@ -2,6 +2,6 @@
   "name": "node_modules",
   "globIgnorePaths": [ "**/.package-lock.json" ],
   "tree": {
-    "$path": { "optional": "..\\node_modules" }
+    "$path": { "optional": "../node_modules" }
   }
 }