Used to encrypt/decrypt using simple caesar cipher
npm install @gykh/caesar-cipher> One of the simplest forms of encryption
``
$ npm install --save @gykh/caesar-cipher$3
`
$ npm i -S @gykh/caesar-cipher
Encrypt and decrypt string
`js
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
`js
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)
`js
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 /);
`
#### input
Type: string
Required
#### key
Type: number
Required
key should be a number between 0-25
#### input
Type: string
Required
#### key
Type: number
Required
key should be a number between 0-25
#### input
Type: Buffer
Required
#### key
Type: number
Required
key should be a number between 0-25
#### input
Type: Buffer
Required
#### key
Type: number
Required
key should be a number between 0-25
#### key
Type: number
Required
key should be a number between 0-25
#### key
Type: number`
Required
key should be a number between 0-25
> The Caesar cipher, also known as a shift cipher, is one of the simplest forms of encryption. It is a substitution cipher where each letter in the original message (called the plaintext) is replaced with a letter corresponding to a certain number of letters up or down in the alphabet. Learn more
MIT © 2021 get-your-knowledge-here