npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

browser-storage-helpers

v1.0.6

Published

A utility package for managing cookies, localStorage, and sessionStorage with encryption and decryption support. Includes methods for securely storing, loading, and removing data using modern browser storage mechanisms.

Downloads

33

Readme

browser-storage-helpers

browser-storage-helpers is a utility package for managing cookies, localStorage, and sessionStorage with encryption and decryption support. It includes methods for securely storing, loading, and removing data using modern browser storage mechanisms.

Installation

To install the package, run the following command:

npm install browser-storage-helpers

Features

Securely store, load, and remove data in cookies, localStorage, and sessionStorage. Encrypt and decrypt stored data using XOR encryption. Built-in helpers for easy integration with browser storage mechanisms.

Usage

Importing the Helpers You can import the specific helpers as needed:

import { storeToLocalStorage, loadFromLocalStorage, clearFromLocalStorage } from 'browser-storage-helpers';
import { storeToSessionStorage, loadFromSessionStorage, removeFromSessionStorage } from 'browser-storage-helpers';
import { storeToCookie, loadFromCookie, clearFromCookie } from 'browser-storage-helpers';

LocalStorage Helper Methods

storeToLocalStorage - Stores encrypted data in localStorage.

storeToLocalStorage('user', { name: 'John Doe', email: '[email protected]' });

loadFromLocalStorage - Loads and decrypts data from localStorage.

const user = loadFromLocalStorage('user');
console.log(user); # { name: 'John Doe', email: '[email protected]' }

clearFromLocalStorage - Removes the specified item from localStorage.

clearFromLocalStorage('user');

SessionStorage Helper Methods

storeToSessionStorage - Stores encrypted data in sessionStorage.

storeToSessionStorage('sessionData', { sessionId: '12345' });

loadFromSessionStorage - Loads and decrypts data from sessionStorage.

const sessionData = loadFromSessionStorage('sessionData');
console.log(sessionData); # { sessionId: '12345' }

removeFromSessionStorage - Removes the specified item from sessionStorage.

removeFromSessionStorage('sessionData');

Cookie Helper Methods

storeToCookie - Stores encrypted data in a cookie. You can specify options like path and expiration.

storeToCookie('token', { authToken: 'abc123' }, { path: '/', maxAge: 3600 });

loadFromCookie - Loads and decrypts data from a cookie.

const tokenData = loadFromCookie('token');
console.log(tokenData); # { authToken: 'abc123' }

clearFromCookie - Removes the specified cookie.

clearFromCookie('token', { path: '/' });

Encryption and Decryption

The data stored using localStorage, sessionStorage, and cookies is automatically encrypted using XOR encryption. You can customize the encryption by modifying the encryption key in your .env or project environment variables.

By default, the encryption key is fetched from the environment variable ENCRYPTION_SECRET_KEY.

Environment Variables

The package uses the environment variable ENCRYPTION_SECRET_KEY for encrypting and decrypting data. You should define this variable in your .env file or environment configuration.

For example:

Vite.js (React, Vue) (.env):

VITE_APP_ENCRYPTION_SECRET_KEY=mySuperSecretKey123

React (CRA) (.env):

REACT_APP_ENCRYPTION_SECRET_KEY=mySuperSecretKey123

Vue.js (.env):

VUE_APP_ENCRYPTION_SECRET_KEY=mySuperSecretKey123

Angular (environment.ts):

export const environment = {
  production: false,
  ENCRYPTION_SECRET_KEY: 'mySuperSecretKey123'
};