react-globo-state 1.0.6 → 1.1.0

package/README.md

@@ -1,4 +1,4 @@
-# [React Globo State](https://npmjs.com/package/react-globo-state)
+# [React Globo State - gState.](https://npmjs.com/package/react-globo-state)
 
 A react state everywhere, easy and smart ... Only one!
 
@@ -14,7 +14,7 @@ A react state everywhere, easy and smart ... Only one!
 
 ## install
 
-```sh
+```bash
 npm i -D react-globo-state
 ```
 
@@ -23,7 +23,7 @@ You use:
 ```javascript
 
 // Import the init
-import globoState from "react-globo-state"
+import "react-globo-state"
 
 // start the state
 // * need to be inside your App() only at top and one time...
@@ -37,14 +37,20 @@ globoState()
 ## EXAMPLE
 
 ```js
-import globoState from "react-globo-state"
+import "react-globo-state"
 
 const App = () => {
 
   // init gState
   globoState()
 
-  return <div>MyApp</div>
+  useEffect(
+    ()=>{
+      gState.set("test",{ myNewReactState: "hello world!" })
+    },[]
+  )
+
+  return <div>{ JSON.stringify(gState.get("test")) }</div>
 
 }
 
@@ -61,21 +67,21 @@ const App = () => {
      * Create a state
      * @param name - Name of the gstate
      * @param item - Object, string, number, boolean, array
-     * @returns - Void
+     * @returns - true
     */
     gState.set("name", { test:"test" })
 
     /**
      * Get a state
      * @param name - Name of the gstate
-     * @returns - Void
+     * @returns - items
     */
     gState.get("name")
 
     /**
      * Remove a state
      * @param name - Name of the gstate
-     * @returns - Void
+     * @returns - items
     */
     gState.remove("name")
     // or
@@ -83,13 +89,13 @@ const App = () => {
 
     /**
      * Delete all items from gState
-     * @returns - Void
+     * @returns - true
     */
     gState.deleteAll()
 
     /**
      * List all states
-     * @returns - Void
+     * @returns - items
     */
     gState.list()
 

package/global.d.ts

@@ -8,42 +8,52 @@ declare module 'gState'
 declare module 'globoState'
 
 interface _gState {
+
+  /**
+   * Dynamic index signature for additional properties
+   * @private
+   */
+  [key: string]: any
+
+
   /**
    * Create a state
    * @param name - Name of the gstate
    * @param item - Object, string, number, boolean, array
-   * @returns - Void
+   * @returns - true
   */
-  set: (name: string, value: string | number | string[] | object) => void,
+  set: (name: string, value: string | number | string[] | object) => true,
 
   /**
    * Get a state
    * @param name - Name of the gstate
-   * @returns - Void
+   * @returns - value
   */
-  get: (name: string) => void,
+  get: (name: string) => value,
 
   /**
    * Remove a state
    * @param name - Name of the gstate
-   * @returns - Void
+   * @returns - true
   */
-  remove: (name: string) => void,
-  delete: (name: string) => void,
+  remove: (name: string) => true,
+  delete: (name: string) => true,
 
   /**
    * Delete all items from gState
    * @returns - Void
   */
-  deleteAll: () => void,
+  deleteAll: () => true,
 
   /**
    * List all states
    * @returns - Void
   */
-  list: () => void
+  list: () => values
 }
 
+declare var globoState: () => void
+
 declare var gState: _gState
 type gState = _gState
 

package/index.js

@@ -1 +1 @@
-import{useState as u}from"react";const e={},n=()=>{const[r,l]=u(null);globalThis.gState={get:t=>{if(t&&t)return r?.[t]?r[t]:null},set:(t,o)=>{!t||!o||(e[t]=o,l({...e}))},remove:t=>{t&&(delete e[t],l({...e}))},delete:t=>{t&&gState.remove(t)},deleteAll:()=>{l({})},list:()=>r}};var g=n;export{g as default};
+import{useState as n}from"react";const e={};globalThis.globoState=()=>{const[r,u]=n(null);globalThis.gState={get:t=>{if(t&&t)return r?.[t]?r[t]:null},set:(t,l)=>{if(!(!t||!l))return e[t]=l,u({...e}),!0},remove:t=>{if(t)return delete e[t],u({...e}),!0},delete:t=>{if(t)return gState.remove(t),!0},deleteAll:()=>(u({}),!0),list:()=>r}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-globo-state",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "A react state everywhere made easy",
   "keywords": [
     "react",