Package Exports

@gykh/caesar-cipher
@gykh/caesar-cipher/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gykh/caesar-cipher) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GYKH - caesar-cipher

One of the simplest forms of encryption

Install

$ npm install --save @gykh/caesar-cipher

or

$ npm i -S @gykh/caesar-cipher

Usage

Encrypt and decrypt string

const { encryptString, decryptString } = require("@gykh/caesar-cipher");

...

const encrypted = encryptString(str, 3);

const decrypted = decryptString(encrypted, 3);

console.log(str === decrypted); // true

Encrypt and decrypt buffer

const { encrypt, decrypt } = require("@gykh/caesar-cipher");
const fs = require('fs');
const { promisify } = require('util');
const readFile = promisify(fs.readFile);

...

const encrypted = encrypt(await readFile(inputFile), 3);

const decrypted = decrypt(encrypted, 3);

console.log(buffer == decrypted); // true

Encrypt and decrypt streams (Use this in case of input being large data / file)

const { EncryptTransform, DecryptTransform } = require("@gykh/caesar-cipher");
const fs = require('fs'); 

...

const readStream = fs.createReadStream(inputFile);
const writeStream = fs.createWriteStream(outputFile);

const encryptTransform = new EncryptTransform(3);
const decryptTransform = new DecryptTransform(3);

const stream = readStream
    .pipe(encryptTransform)
    .pipe(decryptTransform)
    .pipe(writeStream)

stream.on("error", () => /* do something */);
stream.on("finish", () => /* do something */);

API

caesar-cipher

.encryptString(input, key)