Merge pull request #27 from alevnyacow/tsdoc-improvements

Fixed some TSDoc errors

Author: alevnyacow

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alevnyacow/shared-react-variables",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Easy and comfortable React state manager",
   "main": "transpiled/index.js",
   "scripts": {

sources/index.ts

@@ -11,9 +11,9 @@ type ReactVariableRewriteHook<T> = () => (
 
 /**
  * Generates a tuple of two hooks: first hook is a React variable generator,
- * second hook can be used to rewrite a whole variable (you don't need this most likely).
+ * second hook can be used to rewrite a whole variable (you don't need this, most likely).
  *
- * @param initialState Initial state of shared React variable.
+ * @param initialState Initial state of a shared React variable.
  */
 function createUseSharedVariable<T extends object>(initialState: T) {
     const variableIdentifier = v4();
@@ -25,7 +25,7 @@ function createUseSharedVariable<T extends object>(initialState: T) {
     /**
      * React hook returning shared React variable.
      *
-     * @param rerenderOnChange Flag can be used to prevent a rerender on React variable changes, when set to true.
+     * @param rerenderOnChange Flag can be used to prevent a rerender on React variable changes, when set to false.
      */
     const useSharedVariable: ReactVariableHook<T> = (
         rerenderOnChange = true

tests/test-application/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
-    "@alevnyacow/shared-react-variables": "file:../../alevnyacow-shared-react-variables-2.0.3.tgz",
+    "@alevnyacow/shared-react-variables": "file:../../alevnyacow-shared-react-variables-2.0.4.tgz",
     "@testing-library/jest-dom": "^5.16.2",
     "@testing-library/react": "^12.1.4",
     "@testing-library/user-event": "^13.5.0",