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

miko-basic-json-encryption

v1.0.3

Published

<!-- @format -->

Downloads

1

Readme

Sure! Below is the README.md file for the custom JSON encryption npm package:

# Custom JSON Encryption

A simple npm package for custom JSON encryption and decryption.

## Installation

You can install the package using npm:

```bash
npm install miko-basic-json-encryption
```

Usage

import { CustomJSONEncryptor } from "miko-basic-json-encryption";

// Create an instance of CustomJSONEncryptor with the encryption key
const encryptionKey = "your_secret_key";
const customEncryptor = new CustomJSONEncryptor(encryptionKey);

// Example JSON object to encrypt
const originalData = { name: "John Doe", age: 30, email: "[email protected]" };

// Encrypt the JSON object
const encryptedJSON = customEncryptor.encryptJSON(originalData);
console.log("Encrypted JSON:", encryptedJSON);

// Decrypt the encrypted data
const decryptedData = customEncryptor.decryptJSON(encryptedJSON);
console.log("Decrypted Data:", decryptedData);

API

generateRandomKey(length: number): string

Generates a random key of the specified length.

  • length: The length of the key to generate.
  • Returns: A random key as a string.

customEncryptJSON(jsonObj: any, key: string): string

Encrypts a JSON object using the custom encryption algorithm.

  • jsonObj: The JSON object to be encrypted.
  • key: The encryption key as a string.
  • Returns: The encrypted data as a string.

customDecryptJSON(encryptedData: string, key: string): any

Decrypts the encrypted data using the custom encryption algorithm.

  • encryptedData: The encrypted data to be decrypted.
  • key: The encryption key as a string.
  • Returns: The decrypted JSON object.

Security Considerations

Please note that this custom encryption algorithm may not provide the same level of security as established encryption algorithms like AES. It is recommended to use well-vetted and widely-used encryption libraries for critical applications.

License

This project is licensed under the MIT License - see the LICENSE file for details.


Make sure to save this content as "README.md" in the root directory of your npm package. This README file will provide an overview of your package, installation instructions, usage examples, and API documentation for the users of your npm package.