dphelper 2.6.4 → 3.0.0

package/documents/USEOBSERVER.md

@@ -1,26 +0,0 @@
-# useObserver
-
-## Overview
-
-This document provides a comprehensive list of all available useObserver functions in the `dpHelper` library along with their descriptions and examples.
-
-## Functions
-
-### useObserver(()=>{ YOUR CODE }, "state.name")
-
-- **Description:** Sets up an useObserver 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 useObserver.
-
-- **Example:**
-  > The format is really similar to React useEffect
-
-  ```javascript
-  useObserver(
-    () => {
-      console.log('State changed:', newValue);
-    }, 'state.test'
-  );
-  ```

package/index.d.ts

@@ -1,22 +0,0 @@
-/*!
-  dphelper
-  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-// VENDORS
-/// <reference path="./types/jquery.d.ts" />
-/// <reference path="./types/idb.d.ts" />
-
-// BY DARIO PASSARIELLO
-/// <reference path="./types/dphelper.d.ts" />
-/// <reference path="./types/memorio.d.ts" />
-/// <reference path="./types/observer.d.ts" />
-/// <reference path="./types/useObserver.d.ts" />
-/// <reference path="./types/state.d.ts" />
-/// <reference path="./types/session.d.ts" />
-/// <reference path="./types/store.d.ts" />
-/// <reference path="./types/cache.d.ts" />
-
-

package/types/cache.d.ts

@@ -1,27 +0,0 @@
-/*!
-  dphelper
-  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
-* Cache is used for internal use only... but you can use if you need.
-* @return Some stuff you cache... usually used for dynamic imports from dphelper.
-*/
-
-interface _cache {
-
-  /**
-  * Create a cache, please use state instead!
-  *
-  * @example
-  * cache.myCache = any
-  *
-  * @since dphelper 1.0.6
-  */
-  [key: string]: any
-}
-
-declare var cache: _cache
-type cache = _cache

package/types/idb.d.ts

@@ -1,21 +0,0 @@
-/*!
-  dphelper
-  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
-* idb is indexedDB simplification by dphelper
-* @return IndexedDB editing and maintain.
-*/
-
-interface _idb {
-  [key: string]: any
-}
-
-declare var idb: _idb
-declare var idbases: any
-
-type idb = _idb
-type idbases = {}

package/types/jquery.d.ts

@@ -1,20 +0,0 @@
-/*!
-  dphelper
-  Copyright (c) 2019 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-declare var $: any
-declare var jQuery: any
-declare module 'jquery'
-
-// ////////////////////////////////////////////////////////////////
-
-interface window {
-  $: any
-  jQuery: any
-}
-
-type $ = {}
-type jQuery = {}

package/types/memorio.d.ts

@@ -1,21 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-////////////////////
-// Global object
-////////////////////
-
-/**
-* @return memorio Root.
-*/
-interface _memorio {}
-
-////////////////////////////////////////////////////////////////////////////
-
-declare var memorio: _memorio
-type memorio = _memorio
-

package/types/observer.d.ts

@@ -1,47 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
-* Observer run a callback anytime the associated state going to change
-* @return Execution of function after state change.
-*/
-interface _observer {
-
-  /**
-  * Generate your observer
-  *
-  * @example
-  * observer("myState", Function)
-  *
-  * @since memorio 1.0.6
-  */
-  (stateName: string, callBack: any): any
-
-  /**
-  * List of active observers
-  *
-  * @example
-  * observer.list()
-  *
-  * @since memorio 1.0.6
-  */
-  readonly list?: () => void
-
-  /**
-  * Remove the active observer (not the state)
-  *
-  * @example
-  * observer.remove("myState")
-  *
-  * @since memorio 1.0.6
-  */
-  readonly remove?: (name: string, callBack?: any, flag?: boolean) => void
-
-}
-
-declare var observer: _observer
-type observer = _observer

package/types/session.d.ts

@@ -1,67 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
- * Create states using: session.set("example",{test:"test"})
-*/
-interface _session {
-
-  /**
-    * Create a new session
-    *
-    * @example
-    * session.set("test","example") // or Array, Object, Number, Functions...
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the session.
-    * @param param The information taht you want to session (Any).
-    * @return boolean
-  */
-  set: (name: string, value: any) => void
-
-  /**
-    * Have back the data from a session.
-    *
-    * @example
-    * session.get("test")
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the session.
-  */
-  get: (name: string) => any
-
-  /**
-    * Delete an existing session:
-    *
-    * @example
-    * session.delete("test")
-    * session.remove("test")
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the session.
-    * @return boolean
-  */
-  delete: (name: string) => boolean | undefined
-  remove: (name: string) => boolean | undefined
-
-  /**
-    * Delete all storages
-    *
-    * @example
-    * session.clearAll()
-    * session.removeAll()
-    *
-    * @since memorio 0.0.1
-    * @return boolean
-  */
-  clearAll: () => boolean
-  removeAll: () => boolean
-
-}
-
-declare var session: _session
-type session = _session

package/types/state.d.ts

@@ -1,71 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
-* If you use only "state" you get the entire Proxy object
-* @return Proxy Object of all states.
-*/
-interface _state {
-
-  /**
-   * Create states using: state.test = "example"
-   *
-   * @example
-   * state.myStuff = any
-   *
-   * @since memorio 0.0.1
-   * @param key The name of the state for which you want to modify the action.
-   * @return The previous values (Any).
-   * Important: Object is a Proxy.
-   */
-  [key: string]: any
-
-  /**
-   * Delete entire state using: state.remove("test")
-   *
-   * @example
-   * state.remove(stateName)
-   *
-   * @since memorio 0.0.1
-   * @param stateName The name of the state for which you want to delete.
-   * @return boolean.
-   */
-  readonly remove?: (stateName: string) => any
-
-  /**
-   * List all states using: state.list
-   *
-   * @example
-   * state.removeAll()
-   *
-   * @since memorio 1.8.92
-   * @return Remove all states.
-   */
-  readonly removeAll?: () => any
-
-  /**
-   * List all states using: state.list
-   *
-   * @example
-   * state.list
-   *
-   * @since memorio 0.0.1
-   * @return Object of all states (Not the Proxy).
-   */
-  readonly list?: (stateName: string) => any
-
-  /**
-  * Generate a message for "memorio"
-  * Note: FOR INTERNAL USE ONLY.
-  * @since memorio 0.0.1
-  */
-  readonly mex?: any
-
-}
-
-declare var state: _state
-type state = _state

package/types/store.d.ts

@@ -1,91 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
- * Create states using: store.set("example",{test:"test"})
-*/
-interface _store {
-
-  /**
-    * Create a new store
-    *
-    * @example
-    * store.set("test","example") // or Array, Object, Number, Functions...
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the store.
-    * @param param The information taht you want to store (Any).
-    * @return boolean
-  */
-  set: (name: string, value: any) => void
-
-  /**
-    * Have back the data from a store.
-    *
-    * @example
-    * store.get("test")
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the store.
-  */
-  get: (name: string) => any
-
-  /**
-    * Delete an existing store:
-    *
-    * @example
-    * store.delete("test")
-    * store.remove("test")
-    *
-    * @since memorio 0.0.1
-    * @param name The String as name to define the store.
-    * @return boolean
-  */
-  delete: (name: string) => boolean | undefined
-  remove: (name: string) => boolean | undefined
-
-  /**
-    * Delete all storages
-    *
-    * @example
-    * store.clearAll()
-    * store.removeAll()
-    *
-    * @since memorio 0.0.1
-    * @return boolean
-  */
-  clearAll: () => boolean
-  removeAll: () => boolean
-
-  /**
-    * Know how much space you have for total storages
-    *
-    * @example
-    * store.quota()
-    *
-    * @since memorio 0.0.1
-    * @return values
-  */
-  quota: () => void
-
-  /**
-    * Get the size of stores an the total
-    *
-    * @example
-    * store.size()
-    *
-    * @since memorio 0.0.1
-    * @return dimension in kb
-  */
-  size: () => number
-
-  // TODO
-  // readonly increaseQuota: (value: number) => void
-}
-
-declare var store: _store
-type store = _store

package/types/useobserver.d.ts

@@ -1,28 +0,0 @@
-/*!
-  memorio
-  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
-  Licensed under MIT License, see
-  https://dario.passariello.ca
-*/
-
-/**
-* useObserver run a callback anytime the associated state going to change
-* @return Execution of function after state change.
-*/
-interface _useObserver {
-
-  /**
-  * Generate your useObserver
-  *
-  * @example
-  * useObserver(Function, "state.myState")
-  *
-  * @since memorio 1.0.6
-  */
-  (func: Function, stateName: string): any
-
-
-}
-
-declare var useObserver: _useObserver
-type useObserver = _useObserver