dphelper 2.6.4 → 3.0.0

package/documents/OBSERVER.md

@@ -1,63 +0,0 @@
-# Observer
-
-## Overview
-
-This document provides a comprehensive list of all available observer functions in the `dphelper` library along with their descriptions and examples.
-
-## Functions
-
-### observer([state.name], [function])
-
-- **Description:** Sets up an observer to monitor state changes and trigger a callback.
-- **Parameters:**
-  - `stateName` (string): The name of the state to monitor.
-  - `callBack` (Function): The callback function to run when the state changes.
-  - `option` (object): Additional options for the observer.
-- **Example:**
-
-  ```javascript
-  observer('state.test', (newValue) => {
-    console.log('State changed:', newValue);
-  });
-  ```
-
-### observer([state.name])
-
-- **Description:** Recall the observer previously generated.
-- **Returns:** Console log with a note
-- **Example:**
-
-  ```javascript
-  observer('state.test');
-  ```
-
-### observer.list
-
-- **Description:** See the list of all your observer (eventListener) actually installed.
-- **Returns:** The list of all installed observers.
-- **Example:**
-
-  ```javascript
-  observer.list;
-  ```
-
-### remove
-
-- **Description:** Remove an observer.
-- **Parameters:**
-  - `name` (string): The name of the observer to remove.
-- **Example:**
-
-  ```javascript
-  observer.remove('state.test');
-  ```
-
-### removeAll
-
-- **Description:** Remove all observers.
-- **Returns:** void
-- **Example:**
-
-  ```javascript
-  observer.removeAll();
-  ```

package/documents/SESSION.md

@@ -1,54 +0,0 @@
-# dpHelper Session
-
-## Overview
-
-This document provides a comprehensive list of all available session functions in the `dphelper` library along with their descriptions and examples.
-
-**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
-
-## Functions
-
-### session.get([session.name])
-
-- **Description:** Retrieve an item from session storage.
-- **Parameters:**
-  - `name` (string): The name of the item to retrieve.
-- **Example:**
-
-  ```javascript
-  const value = session.get('itemName');
-  console.log(value);
-  ```
-
-### session.set([name, value])
-
-- **Description:** Set an item in session storage.
-- **Parameters:**
-  - `name` (string): The name of the item to set.
-  - `value` (any): The value of the item to set.
-- **Example:**
-
-  ```javascript
-  session.set('itemName', value);
-  ```
-
-### session.remove([session.name])
-
-- **Description:** Delete an item from session storage.
-- **Parameters:**
-  - `name` (string): The name of the item to delete.
-- **Example:**
-
-  ```javascript
-  session.remove('itemName');
-  ```
-
-### session.removeAll()
-
-- **Description:** Remove all items from session storage.
-- **Parameters:** None
-- **Example:**
-
-  ```javascript
-  session.removeAll();
-  ```

package/documents/STATE.md

@@ -1,65 +0,0 @@
-# dpHelper State
-
-## Overview
-
-This document provides a comprehensive list of all available state functions in the `dphelper` library along with their descriptions and examples.
-
-**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
-
-## Functions
-
-### state.[state.name] ex: _state.test_
-
-- **Description:** Set and get state values.
-- **Example:**
-
-  ```javascript
-  // To set a state value
-  state.name = 'value';
-
-  // To get a state value
-  const value = state.name;
-  ```
-
-### state.list
-
-- **Description:** Show all states out of proxy.
-- **Example:**
-
-  ```javascript
-  state.list;
-  ```
-
-### state.remove([state.name])
-
-- **Description:** Remove a state.
-- **Parameters:**
-  - `name` (string): The name of the state to remove.
-- **Example:**
-
-  ```javascript
-  state.remove('stateName');
-  ```
-
-### state.name.lock()
-
-- **Description:** Lock a state (only for types: Array, Object).
-- **Example:**
-
-  ```javascript
-  state.name = {test:"test"}
-  state.name.lock();
-  "Now you can't add more data or remove it"
-  ```
-
-### state.removeAll()
-
-- **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"
-  ```

package/documents/STORE.md

@@ -1,76 +0,0 @@
-# dpHelper Store
-
-## Overview
-
-This document provides a comprehensive list of all available store functions in the `dphelper` library along with their descriptions and examples.
-
-**Based on [Memorio](https://www.npmjs.com/package/memorio) by Dario Passariello** to manage STATE, STORE, SESSION and OBSERVER. You can use Memorio is you need only state management. DpHelper is indicate when you use a complete suite of tools.
-
-## 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);
-  ```

package/documents/SUMMARY.md

@@ -1,24 +0,0 @@
-# Table of contents
-
-* [dpHelper](README.md)
-
-## General
-
-* [State](/documents/STATE.md)
-* [Observer](/documents/OBSERVER.md)
-* [useObserver](/documents/USEOBSERVER.md)
-* [Store](/documents/STORE.md)
-* [Session](/documents/SESSION.md)
-* [All Functions](/documents/TOOLS.md)
-
-<!-- ## documents
-
-* [License](LICENSE.md)
-* [Contributing](CONTRIBUTING.md)
-* [Code of Conduct](CODE_OF_CONDUCT.md)
-* [Security](SECURITY.md) -->
-
-<!-- ## changes
-
-* [Changelog](CAHNGELOG.md)
-* [History](HISTORY.md) -->