dphelper 1.8.82 → 1.8.92

package/README.md

@@ -116,24 +116,31 @@ You can use the browser's devtools console and type " **state.test = 'I am ready
 
 ```javascript
 // Set a state
-state.test = "I am ready";
+state.test = "I am ready" *
 
 // Get the state
-state.test
+state.test *
 
 // List all states
 state.list // or just "state" to see the proxy
 
+// Lock a state from edit (Only for Objects or Array)
+state.test.lock() *
+
 // Remove a state
 state.remove("test")
+
+// Remove all states
+state.removeAll()
+
+*["test" is only an example]
+
 ```
 
 ### Observer 😎 for States
 
 **Note**: _Observer works only with states. Stores are excluded at the moment._
 
-🔥NEW🔥: Great, now you can use nested objects in observer. You need to declare "state." or "store." before selecting the object you want to monitor.
-
 If you want to run a function every time a state changes, you can use:
 
 ```javascript
@@ -199,7 +206,7 @@ When using dpHelper for permanent storage, you should use the **store**, which s
 
 2. **Remove data when necessary:** To maintain security, remove stored data when it is no longer needed, such as during logout.
 
-3. **Clear all stored data:** Use store.clearAll() to securely remove all stored data from your application.
+3. **Remove all stored data:** Use store.removeAll() to securely remove all stored data from your application.
 
 ```javascript
 // Set a store:
@@ -209,10 +216,10 @@ store.set("test", { test: "test" })
 store.get("test") // Output: { test: "test" }
 
 // Remove a store:
-store.delete("test") // Output: "ok"
+store.remove("test") // Output: "ok"
 
 // Remove all stores:
-store.clearAll() // Output: "ok"
+store.removeAll() // Output: "ok"
 ```
 
 ### Example in React
@@ -240,8 +247,8 @@ function App() {
     }, []
   );
 
-  // Clear all stored data if necessary
-  // store.clearAll();
+  // Remove all stored data if necessary
+  // store.removeAll();
 
   return (
     <div>
@@ -269,7 +276,7 @@ Chrome: [Download from Google Web Store](https://chrome.google.com/webstore/deta
 
 Edge: [Download from Microsoft Addons](https://microsoftedge.microsoft.com/addons/detail/dphelper-manager-dev-to/kphabkbdpaljlfagldhojilhfammepnk)
 
-PS: **dpHelper** is compatible with all Chromium-based browsers like **Brave** too!
+PS: **dpHelper** is compatible with all Chromium-based browsers like **Edge or Brave**!
 
 ## dpHelper Browser Extension
 
@@ -291,10 +298,10 @@ The dpHelper browser extension allows you to manage your application's dpHelper
 
 [MIT - https://en.wikipedia.org/wiki/MIT_License](https://en.wikipedia.org/wiki/MIT_License)
 
-- [LICENCE](https://passariello.gitbook.io/dphelper-devtools/general/license)
-- [CODE OF CONDUCT](https://passariello.gitbook.io/dphelper-devtools/general/code_of_conduct)
-- [SECURITY](https://passariello.gitbook.io/dphelper-devtools/general/security)
-- [CONTRIBUTING](https://passariello.gitbook.io/dphelper-devtools/general/contributing)
+- [LICENCE](https://passariello.gitbook.io/dphelper-devtools/documents/license)
+- [CODE OF CONDUCT](https://passariello.gitbook.io/dphelper-devtools/documents/code_of_conduct)
+- [SECURITY](https://passariello.gitbook.io/dphelper-devtools/documents/security)
+- [CONTRIBUTING](https://passariello.gitbook.io/dphelper-devtools/documents/contributing)
 
 ---
 

package/docs/index.md

@@ -116,24 +116,31 @@ You can use the browser's devtools console and type " **state.test = 'I am ready
 
 ```javascript
 // Set a state
-state.test = "I am ready";
+state.test = "I am ready" *
 
 // Get the state
-state.test
+state.test *
 
 // List all states
 state.list // or just "state" to see the proxy
 
+// Lock a state from edit (Only for Objects or Array)
+state.test.lock() *
+
 // Remove a state
 state.remove("test")
+
+// Remove all states
+state.removeAll()
+
+*["test" is only an example]
+
 ```
 
 ### Observer 😎 for States
 
 **Note**: _Observer works only with states. Stores are excluded at the moment._
 
-🔥NEW🔥: Great, now you can use nested objects in observer. You need to declare "state." or "store." before selecting the object you want to monitor.
-
 If you want to run a function every time a state changes, you can use:
 
 ```javascript
@@ -199,7 +206,7 @@ When using dpHelper for permanent storage, you should use the **store**, which s
 
 2. **Remove data when necessary:** To maintain security, remove stored data when it is no longer needed, such as during logout.
 
-3. **Clear all stored data:** Use store.clearAll() to securely remove all stored data from your application.
+3. **Remove all stored data:** Use store.removeAll() to securely remove all stored data from your application.
 
 ```javascript
 // Set a store:
@@ -209,10 +216,10 @@ store.set("test", { test: "test" })
 store.get("test") // Output: { test: "test" }
 
 // Remove a store:
-store.delete("test") // Output: "ok"
+store.remove("test") // Output: "ok"
 
 // Remove all stores:
-store.clearAll() // Output: "ok"
+store.removeAll() // Output: "ok"
 ```
 
 ### Example in React
@@ -240,8 +247,8 @@ function App() {
     }, []
   );
 
-  // Clear all stored data if necessary
-  // store.clearAll();
+  // Remove all stored data if necessary
+  // store.removeAll();
 
   return (
     <div>
@@ -269,7 +276,7 @@ Chrome: [Download from Google Web Store](https://chrome.google.com/webstore/deta
 
 Edge: [Download from Microsoft Addons](https://microsoftedge.microsoft.com/addons/detail/dphelper-manager-dev-to/kphabkbdpaljlfagldhojilhfammepnk)
 
-PS: **dpHelper** is compatible with all Chromium-based browsers like **Brave** too!
+PS: **dpHelper** is compatible with all Chromium-based browsers like **Edge or Brave**!
 
 ## dpHelper Browser Extension
 
@@ -291,10 +298,10 @@ The dpHelper browser extension allows you to manage your application's dpHelper
 
 [MIT - https://en.wikipedia.org/wiki/MIT_License](https://en.wikipedia.org/wiki/MIT_License)
 
-- [LICENCE](https://passariello.gitbook.io/dphelper-devtools/general/license)
-- [CODE OF CONDUCT](https://passariello.gitbook.io/dphelper-devtools/general/code_of_conduct)
-- [SECURITY](https://passariello.gitbook.io/dphelper-devtools/general/security)
-- [CONTRIBUTING](https://passariello.gitbook.io/dphelper-devtools/general/contributing)
+- [LICENCE](https://passariello.gitbook.io/dphelper-devtools/documents/license)
+- [CODE OF CONDUCT](https://passariello.gitbook.io/dphelper-devtools/documents/code_of_conduct)
+- [SECURITY](https://passariello.gitbook.io/dphelper-devtools/documents/security)
+- [CONTRIBUTING](https://passariello.gitbook.io/dphelper-devtools/documents/contributing)
 
 ---
 

package/documents/STATE.md

@@ -3,10 +3,6 @@
 ## Overview
 This document provides a comprehensive list of all available state functions in the `dphelper` library along with their descriptions and examples.
 
-### News :)
-Now if you try to override the root state you get a message error!
-Also, now you can lock a state using example: __state.[stateName].lock()__
-
 ## Functions
 
 ### state.[state.name] ex: _state.test_
@@ -39,7 +35,7 @@ Also, now you can lock a state using example: __state.[stateName].lock()__
 ### state.name.lock()
 
 >>> New option!
-- **Description:** Lock a state.
+- **Description:** Lock a state (only for types: Array, Object).
 - **Example:**
   ```javascript
   state.name = {test:"test"}
@@ -47,5 +43,17 @@ Also, now you can lock a state using example: __state.[stateName].lock()__
   "Now you can't add more data or remove it"
   ```
 
+### state.removeAll()
+
+>>> New option!
+- **Description:** Remove all states.
+- **Example:**
+  ```javascript
+  state.name = {test:"test"}
+  state.removeAll();
+  "Now you can't see state.name (all states are removed)"
+  "Use for Log-out / Sign-out operation"
+  ```
+
 ## License
 This project is licensed under the MIT License.

package/documents/STORE.md

@@ -1,64 +1,64 @@
-# dpHelper Store
-
-## Overview
-This document provides a comprehensive list of all available store functions in the `dphelper` library along with their descriptions and examples.
-
-## Functions
-
-### store.get([store.name])
-- **Description:** Retrieve an item from local storage.
-- **Parameters:**
-  - `name` (string): The name of the item to retrieve.
-- **Example:**
-  ```javascript
-  const value = store.get('itemName');
-  console.log(value);
-  ```
-
-### store.set([name, value])
-- **Description:** Set an item in local storage.
-- **Parameters:**
-  - `name` (string): The name of the item to set.
-  - `value` (any): The value of the item to set.
-- **Example:**
-  ```javascript
-  store.set('itemName', value);
-  ```
-
-### store.delete([store.name])
-- **Description:** Delete an item from local storage.
-- **Parameters:**
-  - `name` (string): The name of the item to delete.
-- **Example:**
-  ```javascript
-  store.delete('itemName');
-  ```
-
-### store.clearAll()
-- **Description:** Clear all items from local storage.
-- **Parameters:** None
-- **Example:**
-  ```javascript
-  store.clearAll();
-  ```
-
-### store.quota()
-- **Description:** Estimate the storage quota and usage.
-- **Parameters:** None
-- **Example:**
-  ```javascript
-  const quota = store.quota();
-  console.log(quota);
-  ```
-
-### store.size()
-- **Description:** Calculate the total size of all items in local storage.
-- **Parameters:** None
-- **Example:**
-  ```javascript
-  const totalSize = store.size();
-  console.log(totalSize);
-  ```
-
-## License
-This project is licensed under the MIT License.
+# dpHelper Store
+
+## Overview
+This document provides a comprehensive list of all available store functions in the `dphelper` library along with their descriptions and examples.
+
+## Functions
+
+### store.get([store.name])
+- **Description:** Retrieve an item from local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to retrieve.
+- **Example:**
+  ```javascript
+  const value = store.get('itemName');
+  console.log(value);
+  ```
+
+### store.set([name, value])
+- **Description:** Set an item in local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to set.
+  - `value` (any): The value of the item to set.
+- **Example:**
+  ```javascript
+  store.set('itemName', value);
+  ```
+
+### store.remove([store.name])
+- **Description:** Delete an item from local storage.
+- **Parameters:**
+  - `name` (string): The name of the item to delete.
+- **Example:**
+  ```javascript
+  store.remove('itemName');
+  ```
+
+### store.removeAll()
+- **Description:** Remove all items from local storage.
+- **Parameters:** None
+- **Example:**
+  ```javascript
+  store.removeAll();
+  ```
+
+### store.quota()
+- **Description:** Estimate the storage quota and usage.
+- **Parameters:** None
+- **Example:**
+  ```javascript
+  const quota = store.quota();
+  console.log(quota);
+  ```
+
+### store.size()
+- **Description:** Calculate the total size of all items in local storage.
+- **Parameters:** None
+- **Example:**
+  ```javascript
+  const totalSize = store.size();
+  console.log(totalSize);
+  ```
+
+## License
+This project is licensed under the MIT License.