1.0.2 • Published 2 years ago
@oliveringle/caesar-cipher v1.0.2
Caesar cipher
Description
A Caesar cypher consists of shifting the charactersd of an input by a spectifed amount amongst a list of characters.
Instalation
npm i @oliveringle/caesar-cipher
Syntax
Import
with
require
const caesarCipher = require('@oliveringle/caesar-cipher'); //or const { cipher, deCipher } = require('@oliveringle/caesar-cipher');
with
import
import { cipher, deCipher } from '@oliveringle/caesar-cipher';
Usage
cipher(text, shift);
deCipher(text, shift);
- text (
type: string
) is the input that you want to cipher. it may contain alphanumeric caracters, as well as spaces. - shift (
type: number
) is the number of characters to shift by.
Examples
*Using character set defined in caesar-cipher.js*
cipher("a", 2)
would return a value of"c"
cipher("Hello world", 16)
would return a value of"xu225pb582t"
deCipher("c", 2)
would return a value of"a"
deCipher("xu225pb582t", 16)
would return a value of"hello world"
CLI tool
Caesar cipher is also a cli tool. Run the following command to try it out:
npx @oliveringle/caesar-cipher
(Make sure you have Node.js installed and up to date on your system)