@quenty/overriddenproperty 3.1.3-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

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

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 @@
 ## OverriddenProperty
 <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,17 +13,9 @@
 
 Sets properties on the client and then replicates them to the server
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/OverriddenProperty">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/overriddenproperty --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `OverriddenProperty.new(robloxInstance, propertyName, replicateRate, replicateCallback)`
-
-### `OverriddenProperty:Set(value)`
-
-### `OverriddenProperty:Get()`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/overriddenproperty",
-  "version": "3.1.3-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Sets properties on the client and then replicates them to the server",
   "keywords": [
     "Roblox",
@@ -25,12 +25,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "3.1.3-canary.c50dead.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/throttle": "3.1.2-canary.c50dead.0"
+    "@quenty/baseobject": "^3.2.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/throttle": "^3.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/OverriddenProperty.lua

@@ -1,5 +1,7 @@
---- Sets properties on the client and then replicates them to the server
--- @classmod OverriddenProperty
+--[=[
+	Sets properties on the client and then replicates them to the server
+	@class OverriddenProperty
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,9 +12,15 @@ local OverriddenProperty = setmetatable({}, BaseObject)
 OverriddenProperty.ClassName = "OverriddenProperty"
 OverriddenProperty.__index = OverriddenProperty
 
----
--- @param[opt=nil] replicateRate Optional replication rate and callback
--- @param[opt=nil] replicateCallback
+--[=[
+	Constructs a new OverriddenProperty.
+
+	@param robloxInstance Instance
+	@param propertyName string
+	@param replicateRate number? -- Optional replication rate and callback
+	@param replicateCallback (T)?
+	@return OverriddenProperty
+]=]
 function OverriddenProperty.new(robloxInstance, propertyName, replicateRate, replicateCallback)
 	local self = setmetatable(BaseObject.new(robloxInstance), OverriddenProperty)
 
@@ -36,6 +44,11 @@ function OverriddenProperty.new(robloxInstance, propertyName, replicateRate, rep
 	return self
 end
 
+--[=[
+	Sets the property
+
+	@param value T
+]=]
 function OverriddenProperty:Set(value)
 	assert(typeof(value) == typeof(self._value), "Bad value")
 
@@ -43,6 +56,11 @@ function OverriddenProperty:Set(value)
 	self:_executeSet(true)
 end
 
+--[=[
+	Gets the property
+
+	@return T
+]=]
 function OverriddenProperty:Get()
 	return self._value
 end