@raycas/storage-crypter
TypeScript icon, indicating that this package has built-in type declarations

0.0.5 • Public • Published

Storage-Crypter 🚀

Language: TypeScript Version

Storage-Crypter is a light and simple library made with crypto-es that allow you to encrypt and decrypt the values present in your Local or Session Storage

Install

You can install it through the npm packet manager typing

npm i @raycas/storage-crypter

Usage

It is very simple to use and you can use it with vanilla JavaScript or with Framework like Angular o library like React.

Set Item

It Allows you to set the pair key value inside the store (the default value of the storage is session but you can change it to local)

setItem(key, value, (storage = 'session'));

Get Item

It Allows you to get the value associated at the given key (the default value of the storage is session but you can change it to local) if empty it will return an empty string

getItem(key, (storage = 'session'));

Remove Item

It Allows you to remove the pair key value associated at the given key from the storage (the default value of the storage is session but you can change it to local)

removeItem(key, (storage = 'session'));

Switch Items

It Allows you to switch the pair key value associated at the given key from/to local/session Storage (if the operation is successful return true else false)

switchFromLocal(key);
switchFromSession(key);

Examples 🔭

import { storageCrypter } from '@raycas/storage-crypter';
/** Initialize the class with your secret key */
const {setItem, getItem, removeItem} =  storageCrypter('Secret');
/** local storage */
const set = () => storageCrypter.setItem('example', 'value', 'local');
const remove = () => storageCrypter.removeItem('example', 'local');
const get = () => console.log(storageCrypter.getItem('example', 'local'));
storageCrypter.switchFromLocal('example');
/** session storage */
const set = () => storageCrypter.setItem('example', 'value');
const remove = () => storageCrypter.removeItem('example');
const get = () => console.log(storageCrypter.getItem('example'));
storageCrypter.switchFromSession('example');

Demo 🔭

Angular

Demo

React

Demo

Package Sidebar

Install

npm i @raycas/storage-crypter

Weekly Downloads

1

Version

0.0.5

License

MIT

Unpacked Size

6.6 kB

Total Files

3

Last publish

Collaborators

  • raycas