react-globo-state 1.0.5 → 1.0.7

package/README.md

@@ -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,7 +37,7 @@ globoState()
 ## EXAMPLE
 
 ```js
-import globoState from "react-globo-state"
+import "react-globo-state"
 
 const App = () => {
 
@@ -57,20 +57,40 @@ const App = () => {
   // now you can use your global react state everywhere.
   // you can use also in useEffect and Dispatch
 
-    // Create a state
+    /**
+     * Create a state
+     * @param name - Name of the gstate
+     * @param item - Object, string, number, boolean, array
+     * @returns - Void
+    */
     gState.set("name", { test:"test" })
 
-    // Get a state
+    /**
+     * Get a state
+     * @param name - Name of the gstate
+     * @returns - Void
+    */
     gState.get("name")
 
-    // Remove a state
+    /**
+     * Remove a state
+     * @param name - Name of the gstate
+     * @returns - Void
+    */
     gState.remove("name")
     // or
     gState.delete("name")
 
-    // gState.deleteAll() // coming soon
+    /**
+     * Delete all items from gState
+     * @returns - Void
+    */
+    gState.deleteAll()
 
-    // List all states
+    /**
+     * List all states
+     * @returns - Void
+    */
     gState.list()
 
 ```

package/global.d.ts

@@ -4,14 +4,51 @@
   https://dario.passariello.ca
 */
 
+declare module 'gState'
+declare module 'globoState'
+
 interface _gState {
+
+  init: () => void,
+  /**
+   * Create a state
+   * @param name - Name of the gstate
+   * @param item - Object, string, number, boolean, array
+   * @returns - Void
+  */
   set: (name: string, value: string | number | string[] | object) => void,
+
+  /**
+   * Get a state
+   * @param name - Name of the gstate
+   * @returns - Void
+  */
   get: (name: string) => void,
+
+  /**
+   * Remove a state
+   * @param name - Name of the gstate
+   * @returns - Void
+  */
   remove: (name: string) => void,
   delete: (name: string) => void,
+
+  /**
+   * Delete all items from gState
+   * @returns - Void
+  */
   deleteAll: () => void,
+
+  /**
+   * List all states
+   * @returns - Void
+  */
   list: () => void
 }
 
+declare var globoState: () => void
+
 declare var gState: _gState
 type gState = _gState
+
+globalThis.gState = _gState

package/index.js

@@ -1 +1 @@
-import{useState as n}from"react";const e={},u=()=>{const[r,l]=n(null);return 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},u};var f=u;export{f as default,u as globoState};
+import{useState as g}from"react";const e={};globalThis.globoState=()=>{const[r,l]=g(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}};

package/package.json

@@ -1,39 +1,49 @@
-{
-  "name": "react-globo-state",
-  "version": "1.0.5",
-  "description": "A react state everywhere made easy",
-  "keywords": [
-    "react",
-    "state",
-    "render",
-    "global",
-    "dario",
-    "passariello"
-  ],
-  "files": [
-    "index.js",
-    "global.d.ts"
-  ],
-  "license": "MIT",
-  "author": "Dario Passariello",
-  "type": "module",
-  "main": "./index.js",
-  "types": "./global.d.ts",
-  "dependencies": {
-    "react": "^19.2.3"
-  },
-  "scripts": {
-    "build": "node ./esbuild.config.mjs",
-    "npm:publish": "npm run build && npm publish ./dist"
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "8.53.0",
-    "@typescript-eslint/parser": "8.53.0",
-    "esbuild": "0.27.2",
-    "esbuild-plugin-copy": "2.1.1",
-    "eslint": "9.39.2",
-    "ts-jest": "29.4.6",
-    "tslib": "^2.8.1",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "react-globo-state",
+  "version": "1.0.7",
+  "description": "A react state everywhere made easy",
+  "keywords": [
+    "react",
+    "state",
+    "render",
+    "global",
+    "dario",
+    "passariello"
+  ],
+  "files": [
+    "index.js",
+    "global.d.ts"
+  ],
+  "license": "MIT",
+  "author": "Dario Passariello",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./global.d.ts",
+  "typings": "./global",
+  "extends": "./tsconfig.json",
+  "exports": {
+    ".": {
+      "types": "./global.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "scripts": {
+    "build": "node ./esbuild.config.mjs",
+    "npm:publish": "npm run build && npm publish ./dist"
+  },
+  "dependencies": {
+    "react": "^19.2.3"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "8.53.0",
+    "@typescript-eslint/parser": "8.53.0",
+    "esbuild": "0.27.2",
+    "esbuild-plugin-copy": "2.1.1",
+    "eslint": "9.39.2",
+    "ts-jest": "29.4.6",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3"
+  }
+}