Skip to content

Latest commit

 

History

History
213 lines (140 loc) · 4.99 KB

README.md

File metadata and controls

213 lines (140 loc) · 4.99 KB
Raw

StorageWebManager


Maintain cookies, sessionStorage like never before.

Manager Cookies, sessionStorage without any big messy codes.

npm


StorageWebManager can be used for :

Usage

npm install

 npm i storagewebmanager

Using package CDN:

 <script src="https://raw.githubusercontent.com/sayyedrizwan/storagewebmanager/master/src/indexvanilla.js"></script>

Manager Cookies

• import Component

 import { createCookie, deleteCookie, createVaildityCookie, updateCookie, accessCookie, clearCookies} from 'storagewebmanager';

Import only that Component which you are going to use.


• create a cookie

 createCookie("CookieName", "CookieValue");

• Access a cookie

 accessCookie("CookieName"); //return null if cookie not found

• Delete a cookie

 deleteCookie("CookieName"); //return null if cookie not found

• create a cookie for particular days

 createVaildityCookie("CookieName", "CookieValue", 5); //5 is number of you want to keep cookies in the Storage

• Update a cookie

 updateCookie("CookieName", "CookieValue", 5); //5 is number of you want to extend cookies expiry in the Storage

• Clear cookie storage

 clearCookies();

• If saving Array in cookies

 var data = { name: "Rizwan Sayyed", age: 22, location: "India" }
 createCookie("CookieName", JSON.stringify(data));

SWM have inbuild array dection, If it throw error and did not save json format add JSON.stringify(); to get the output



Manager LocalStorage

• import Component

 import { addLocalStorage, localStorage} from 'storagewebmanager';

Import only that Component which you are going to use.


• Add a LocalStorage

 addLocalStorage("storageName", "storageValue");

• Remove, Removeall, Get a LocalStorage

 localStorage("storageName", "get");

For Remove add "remove" in place of get, "removeall" for delete all data from LocalStorage, "get" to return storagevalue.



Manager SessionStorage

• import Component

 import { addsessionStorage, sessionStorage} from 'storagewebmanager';

Import only that Component which you are going to use. Return 0 if SessionStorage is not supported by browser


• Add a SessionStorage

 addsessionStorage("storageName", "storageValue");

• Remove, Removeall, Get a sessionStorage

 sessionStorage("storageName", "get");

For Remove add "remove" in place of get, "removeall" for delete all data from SessionStorage, "get" to return storagevalue.



Authenticate User

• import Component

 import { userAuth, userAuthSet} from 'storagewebmanager';

Import only that Component which you are going to use.


  • userAuthSet("uidValue", "add"); //Add user unique value to help you in future (you can use "add", "remove", "get")

  • userAuth(); //return true if you have uid set (Developer can authenticate using it).



NPM

  • NPM - View storagewebmanager on npmjs.


Contribute

Contributions are always welcome! 😊

Contact me on my email sayyedrizwanahmed@gmail.com for any query.


MIT License

Copyright (c) Rizwan Sayyed. and its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.