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

localcrypt

v1.0.3

Published

A JavaScript library for secure local storage using AES encryption.

Downloads

19

Readme

LocalCrypt

LocalCrypt is a JavaScript library for secure local storage using AES encryption.

Installation

To install the LocalCrypt library, use npm:

npm install localcrypt

Usage (ES6)

Here is an example of how to use the LocalCrypt library:

"use client"

// Importing SecureStorage classes
import SecureStorage from 'localcrypt/SecureStorage';
const secureStorage = new SecureStorage();

// Setting an item in secure storage
secureStorage.setItem('username', 'victor');

// Getting an item from secure storage
console.log(secureStorage.getItem('username')); // Outputs: victor

API Documentation

LocalCrypt

constructor(secretKey)

  • Parameters:
    • secretKey (string): The secret key used for AES encryption and decryption.

encrypt(data)

  • Parameters:
    • data (string): The plaintext data to encrypt.
  • Returns:
    • (string): The encrypted data.

decrypt(encryptedData)

  • Parameters:
    • encryptedData (string): The encrypted data to decrypt.
  • Returns:
    • (string): The decrypted plaintext data.

SecureStorage

constructor(localCrypt)

  • Parameters:
    • localCrypt (LocalCrypt): An instance of the LocalCrypt class.

setItem(key, value)

  • Parameters:
    • key (string): The key under which the value is stored.
    • value (string): The plaintext value to store.
  • Returns:
    • None

getItem(key)

  • Parameters:
    • key (string): The key of the stored value.
  • Returns:
    • (string): The decrypted value stored under the given key.

Running Tests

To run the tests for the LocalCrypt library, use the following command:

npm test

Make sure you have jest installed as a development dependency to run the tests.

Contributing

We welcome contributions to the LocalCrypt library. If you have any suggestions, bug reports, or improvements, please open an issue or submit a pull request on GitHub.