opendb-store 1.0.2 → 1.0.4

package/README.md

@@ -4,8 +4,22 @@
 
 ## Core Database Object Method
 
-local - Contain localStorage methods
-session - Contain sessionStorage methods
+> local - Contain localStorage methods
+
+> session - Contain sessionStorage methods
+
+## Installation Guide
+```
+npm i opendb-store
+```
+
+## Import opendb-store in Your Project
+```
+import db from 'opendb-store'
+
+db.local.set('libname', 'OpenDB Store');
+console.log('Welcome to: ', db.local.get('libname'));
+```
 
 ## Local Storage
 
@@ -58,14 +72,73 @@ For further details, see the [old-approach](https://github.com/pankajbisht/openD
 
 ## List of Local and Session Storage Methods
 
+### set(key: string, value: any): void
+Stores data in local or session storage with a key and value.
+Example:
+```javascript
+
+db.local.set('libname', 'OpenDB Store'); // Set simple value
+db.local.set('object', { name: 'OpenDB Store', version: 'x.y.z' }); // Set Object Value
+db.local.set('array', ['OpenDB Store', 'x.y.z']); // Set Array Value
+db.local.set('expiringKey', 'It will expire', { expire: 1 * 1000 }); // Set simple value expire after 1 second
+
+// for session storage
+db.session.set('libname', 'OpenDB Store'); // Set simple value inside session storage
 ```
-- set(key, value) :-  stores data in local or session storage with a key and value
 
-- get(key, defaultValue) :- retrieve data from local or session storage by key.
+### get(key: string, defaultValue: any): any
+Retrieves data from local or session storage by key. Returns defaultValue if the key does not exist.
+
+```javascript
+
+// Get Simple Value
+console.log('Welcome to: ', db.local.get('libname')); // OpenDB Store
+
+// Get Object Value
+console.log('Object: ', db.local.get('object'));
+// Or
+const { name, version } = db.local.get('object', ['name', 'version']);
+console.log(name, version);
+
+// Get Array Value
+console.log('Array: ', db.local.get('array'));
+
+// Get defaultValue
+db.local.get('missingKey', {}); // {} by default it will null
+
+console.log('Before(2 sec) expiringKey', db.local.get('expiringKey'))
+
+(async () => {
+    await new Promise((resolve) => setTimeout(resolve, 2 * 1000));
+    console.log('After(2 sec) expiringKey', db.local.get('expiringKey')); // will get default value
+})();
+
+```
+
+### has(key: string): boolean
+check whether a specified key exists in local or session storage
+
+```javascript
+
+// Checks if a key exists in local storage.
+console.log(db.local.has('libname')); // true
+console.log(db.local.has('missingkey')); // false
+```
+
+### remove(key: string): void
+remove a specific item from local or session storage
+
+```javascript
+
+// Removes a value from storage.
+db.local.remove('libname');
+```
 
-- has(key) :- check whether a specified key exists in local or session storage
+### clear(): void
+Empty the entire storage.
 
-- remove(key) :- remove a specific item from local or session storage
+```javascript
 
-- clear() :- Empty the entire storage.
+// Clears all data from local storage
+db.local.clear();
 ```

package/dist/opendb-esm.js

@@ -33,7 +33,7 @@ function generateKey(key) {
   return `${config$1.namespace}${config$1.separator}${key}`;
 }
 
-const version = '1.0.2';
+const version = '1.0.4';
 
 var config = {
   version,
@@ -86,7 +86,7 @@ function get(key, defaultValue = null) {
   const value = this.storage.getItem(namespacedKey);
 
   if (util.isNull(value)) {
-    return null;
+    return defaultValue;
   }
 
   try {

package/dist/opendb-esm.min.js

@@ -1 +1 @@
-const config$1={namespace:"app",separator:".",trimKeys:!0,expiry:!0};function createNamespace(e){config$1.namespace=e}function switchNamespace(e){config$1.namespace=e}function getCurrentNamespace(){return config$1.namespace}function get$1(){return config$1}function setSeparator(e){config$1.separator=e}function getSeparator(){return config$1.separator}function generateKey(e){return`${config$1.namespace}${config$1.separator}${e}`}const version="1.0.2";var config={version:"1.0.2",createNamespace:createNamespace,getCurrentNamespace:getCurrentNamespace,switchNamespace:switchNamespace,get:get$1,setSeparator:setSeparator,getSeparator:getSeparator,generateKey:generateKey};function from(e){e&&switchNamespace(e)}function parse(e){try{return JSON.parse(e)}catch{return e}}function isUndefined(e){return void 0===e}function isNull(e){return null===e||"null"===e}var util={parse:parse,isUndefined:isUndefined,isNull:isNull};function isInvalidArg(e){return isUndefined(e)||isNull(e)}function get(e,t=null){if(isInvalidArg(e))return null;const r=config.generateKey(e),n=this.storage.getItem(r);if(util.isNull(n))return null;try{let r=util.parse(n);return r.expire&&Date.now()>r.expire?(this.remove(e),t):r.value}catch{return t}}function set(e,t,r={}){if(isInvalidArg(e))return null;const n=config.generateKey(e),{expire:a}=r;let o={value:t,...a?{expire:Date.now()+a}:{}};this.storage.setItem(n,JSON.stringify(o))}function has(e){return!!this.get(e)}function remove(e){const t=config.generateKey(e);return this.storage.removeItem(t)}function clear(){return this.storage.clear()}function key(e){return this.storage.key(e)}function keys(){const e=[];for(let t=0;t<this.storage.length;t++)e.push(this.storage.key(t));return e}function trim(e){return this.storage.get(e).trim()}function setFormattedData(e,t){const r=getSeparator();for(let n in t)n in t&&this.set(`${e}${r}${n}`,t[n])}function getFormattedData(e){const t={},r=getSeparator();for(let n=0,a=this.storage.length;n<a;n++){const a=this.key(n),[,o,s]=a.split(`${r}`,3);o===e&&s&&(t[s]=this.get(`${o}${r}${s}`))}return t}var storageMethods={from:from,get:get,set:set,has:has,remove:remove,clear:clear,key:key,keys:keys,trim:trim,getFormattedData:getFormattedData,setFormattedData:setFormattedData};function storageoperations(e){return{storage:e,get count(){return e.length},...storageMethods}}function ensureSupport(e){if(!e)throw new Error("Storage is not supported in this environment.");return e}const db={config:config,local:storageoperations(ensureSupport(window.localStorage)),session:storageoperations(ensureSupport(window.sessionStorage))};export{db as default};
+const config$1={namespace:"app",separator:".",trimKeys:!0,expiry:!0};function createNamespace(e){config$1.namespace=e}function switchNamespace(e){config$1.namespace=e}function getCurrentNamespace(){return config$1.namespace}function get$1(){return config$1}function setSeparator(e){config$1.separator=e}function getSeparator(){return config$1.separator}function generateKey(e){return`${config$1.namespace}${config$1.separator}${e}`}const version="1.0.4";var config={version:"1.0.4",createNamespace:createNamespace,getCurrentNamespace:getCurrentNamespace,switchNamespace:switchNamespace,get:get$1,setSeparator:setSeparator,getSeparator:getSeparator,generateKey:generateKey};function from(e){e&&switchNamespace(e)}function parse(e){try{return JSON.parse(e)}catch{return e}}function isUndefined(e){return void 0===e}function isNull(e){return null===e||"null"===e}var util={parse:parse,isUndefined:isUndefined,isNull:isNull};function isInvalidArg(e){return isUndefined(e)||isNull(e)}function get(e,t=null){if(isInvalidArg(e))return null;const r=config.generateKey(e),n=this.storage.getItem(r);if(util.isNull(n))return t;try{let r=util.parse(n);return r.expire&&Date.now()>r.expire?(this.remove(e),t):r.value}catch{return t}}function set(e,t,r={}){if(isInvalidArg(e))return null;const n=config.generateKey(e),{expire:a}=r;let o={value:t,...a?{expire:Date.now()+a}:{}};this.storage.setItem(n,JSON.stringify(o))}function has(e){return!!this.get(e)}function remove(e){const t=config.generateKey(e);return this.storage.removeItem(t)}function clear(){return this.storage.clear()}function key(e){return this.storage.key(e)}function keys(){const e=[];for(let t=0;t<this.storage.length;t++)e.push(this.storage.key(t));return e}function trim(e){return this.storage.get(e).trim()}function setFormattedData(e,t){const r=getSeparator();for(let n in t)n in t&&this.set(`${e}${r}${n}`,t[n])}function getFormattedData(e){const t={},r=getSeparator();for(let n=0,a=this.storage.length;n<a;n++){const a=this.key(n),[,o,s]=a.split(`${r}`,3);o===e&&s&&(t[s]=this.get(`${o}${r}${s}`))}return t}var storageMethods={from:from,get:get,set:set,has:has,remove:remove,clear:clear,key:key,keys:keys,trim:trim,getFormattedData:getFormattedData,setFormattedData:setFormattedData};function storageoperations(e){return{storage:e,get count(){return e.length},...storageMethods}}function ensureSupport(e){if(!e)throw new Error("Storage is not supported in this environment.");return e}const db={config:config,local:storageoperations(ensureSupport(window.localStorage)),session:storageoperations(ensureSupport(window.sessionStorage))};export{db as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opendb-store",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A lightweight utility to manage browser storage (localStorage, sessionStorage, and cookies) with advanced features. Easily configure namespaces, key trimming, and data expiry.",
   "main": "./dist/opendb-esm.js",
   "type": "module",

package/src/config/version.js

@@ -1 +1 @@
-export const version = '1.0.2';
+export const version = '1.0.4';

package/src/modules/get.js

@@ -8,7 +8,7 @@ export default function get(key, defaultValue = null) {
   const value = this.storage.getItem(namespacedKey);
 
   if (util.isNull(value)) {
-    return null;
+    return defaultValue;
   }
 
   try {