dphelper 1.2.4 → 1.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dphelper",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "displayName": "dphelper",
   "description": "dphelper devtools | tools, store and state management brave developers by Dario Passariello",
   "copyright": "Dario Passariello",
@@ -175,8 +175,6 @@
     "tsc": "tsc -b",
     "oxlint": "oxlint --config=./.eslintrc.json --tsconfig=./tsconfig.json",
     "---": "------------",
-    "jsdoc": "jsdoc -r -c ./jsdoc.json",
-    "jsdoc1": "jsdoc -r -c ./jsdoc.json && jsdoc2md --files index.js > docs/doc.md",
     "pack": "cd dist && npm pack",
     "backup": "cd mcp/batch && backup.bat",
     "update": "cd mcp/javascripts && node npmUpdate"
@@ -189,9 +187,7 @@
     "@babel/preset-react": "7.24.7",
     "@babel/preset-typescript": "7.24.7",
     "@babel/runtime": "^7.25.0",
-    "@types/node": "22.3.0",
-    "@types/react": "^18.3.3",
-    "@types/react-dom": "^18.3.0",
+    "@types/node": "22.4.0",
     "@types/webpack-env": "1.18.5",
     "babel-loader": "9.1.3",
     "compression-webpack-plugin": "11.1.0",
@@ -199,24 +195,10 @@
     "crypto-js": "4.2.0",
     "css": "3.0.0",
     "css-loader": "^7.1.2",
-    "dotenv": "^16.4.5",
     "file-loader": "6.2.0",
-    "fs": "0.0.1-security",
     "html-webpack-plugin": "5.6.0",
     "jquery": "3.7.1",
-    "jsdoc": "4.0.3",
-    "jsdoc-babel": "0.5.0",
-    "jsdoc-to-markdown": "8.0.3",
-    "jsdom-worker": "0.3.0",
-    "jshint": "^2.13.6",
-    "less": "4.2.0",
-    "less-loader": "^12.2.0",
-    "path": "^0.12.7",
     "progress-bar-webpack-plugin": "2.1.0",
-    "react": "18.3.1",
-    "react-dom": "18.3.1",
-    "react-router": "^6.26.0",
-    "react-router-dom": "^6.26.0",
     "sass": "^1.77.8",
     "sass-loader": "^16.0.0",
     "style-loader": "^4.0.0",

package/types/cache.d.ts

@@ -8,6 +8,15 @@ License: MIT
 * @return Some stuff you cache... usually used for dynamic imports from dpHelper.
 */
 interface dpCache {
+
+  /**
+  * Create a cache, please use state instead!
+  *
+  * @example
+  * cache.myCache = any
+  *
+  * @since dpHelper 1.0.6
+  */
   [key: string]: any
 }
 

package/types/observer.d.ts

@@ -1,12 +1,42 @@
+/*
+Copyright: © 2019 Dario Passariello <dariopassariello@gmail.com>
+License: MIT
+*/
+
 /**
 * Observer run a callback anytime the associated state going to change
 * @return Execution of function after state change.
 */
 interface dpObserver {
 
+  /**
+  * Generate your observer
+  *
+  * @example
+  * observer("myState", Function)
+  *
+  * @since dpHelper 1.0.6
+  */
   (stateName: string, callBack): Any
 
+  /**
+  * List of active observers
+  *
+  * @example
+  * observer.list()
+  *
+  * @since dpHelper 1.0.6
+  */
   readonly list?: () => void
+
+  /**
+  * Remove the active observer (not the state)
+  *
+  * @example
+  * observer.remove("myState")
+  *
+  * @since dpHelper 1.0.6
+  */
   readonly remove?: (name: string, callBack, flag?: bool[]) => void
 
 }

package/types/state.d.ts

@@ -6,6 +6,10 @@ interface dpState {
 
   /**
    * Create states using: state.test = "example"
+   *
+   * @example
+   * state.myStuff = any
+   *
    * @since dpHelper 0.0.1
    * @param key The name of the state for which you want to modify the action.
    * @return The previous values (Any).
@@ -15,6 +19,10 @@ interface dpState {
 
   /**
    * Delete entire state using: state.remove("test")
+   *
+   * @example
+   * state.remove(any)
+   *
    * @since dpHelper 0.0.1
    * @param stateName The name of the state for which you want to delete.
    * @return boolean.
@@ -23,6 +31,10 @@ interface dpState {
 
   /**
    * List all states using: state.list
+   *
+   * @example
+   * state.list
+   *
    * @since dpHelper 0.0.1
    * @return Object of all states (Not the Proxy).
    */
@@ -30,8 +42,8 @@ interface dpState {
 
   /**
   * Generate a message for "dpHelper Manage"
+  * Note: FOR INTERNAL USE ONLY.
   * @since dpHelper 0.0.1
-  * Important: FOR INTERNAL USE ONLY.
   */
   readonly mex: (prop: { property: string, value: string }) => any
 

package/types/store.d.ts

@@ -14,7 +14,7 @@ interface dpStore {
     * @param param The information taht you want to store (Any).
     * @return boolean
   */
-  readonly set: (name: string, param: any) => any
+  set(name: string, param: any): any
 
   /**
     * Have back the data from a store.
@@ -25,7 +25,7 @@ interface dpStore {
     * @since dpHelper 0.0.1
     * @param name The String as name to define the store.
   */
-  readonly get: (name: string) => any
+  get(name: string): any
 
   /**
     * Delete an existing store:
@@ -37,7 +37,7 @@ interface dpStore {
     * @param name The String as name to define the store.
     * @return boolean
   */
-  readonly delete: (name: string) => any
+  delete(name: string): any
 
   /**
     * Delete all storages
@@ -48,7 +48,7 @@ interface dpStore {
     * @since dpHelper 0.0.1
     * @return boolean
   */
-  readonly clearAll: () => void
+  clearAll(): any
 
   /**
     * Know how much space you have for total storages
@@ -59,7 +59,7 @@ interface dpStore {
     * @since dpHelper 0.0.1
     * @return values
   */
-  readonly quota: () => void
+  quota(): any
 
   /**
     * Get the size of stores an the total
@@ -70,7 +70,7 @@ interface dpStore {
     * @since dpHelper 0.0.1
     * @return dimension in kb
   */
-  readonly size: () => any
+  size(): any
 
   // TODO
   // readonly increaseQuota: (value: number) => void