https://github.com/yousufkalim/text-encrypter
The library to encrypt/decrypt text using caesar cipher mechanism
https://github.com/yousufkalim/text-encrypter
caesar-cipher decrypt encrypt text
Last synced: 4 months ago
JSON representation
The library to encrypt/decrypt text using caesar cipher mechanism
- Host: GitHub
- URL: https://github.com/yousufkalim/text-encrypter
- Owner: yousufkalim
- License: mit
- Created: 2022-12-08T14:11:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T09:31:25.000Z (about 3 years ago)
- Last Synced: 2025-03-08T10:33:44.088Z (11 months ago)
- Topics: caesar-cipher, decrypt, encrypt, text
- Language: TypeScript
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOGS.md
- License: LICENSE
Awesome Lists containing this project
README
# Text Encrypter
This is very small and lightweight library that is capable to encrypt and decrypt the text using caesar cipher mechanism.
## Installation
Install text-encrypter with npm/yarn
```bash
npm install text-encrypter // npm
yarn add text-encrypter // yarn
```
## Usage/Examples
#### Import
```javascript
import { encrypt, decrypt } from 'text-encrypter'; // ES6
const { encrypt, decrypt } = require('text-encrypter'); // CommonJS
```
#### Data
```javascript
const value = 'Hello World';
const shift = 3; // Default is 1
const ignoreSpecialCharacters = false; // Default is true
```
#### Usage
```javascript
// Encrypt
let encryptedText = encrypt(value, shift, ignoreSpecialCharacters);
// Decrypt
let decryptedText = decrypt(value, shift, ignoreSpecialCharacters);
```
## Contributing
- Fork it!
- Create your feature branch: `git checkout -b my-new-feature`
- Commit your changes: `git commit -am 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request :D
## Author
**text-encrypter** © [Yousuf](https://github.com/yousufkalim)
Authored and maintained by Yousuf Kalim.
> GitHub [@yousufkalim](https://github.com/yousufkalim) · LinkedIn [@yousufkalim](https://www.linkedin.com/in/yousufkalim/)
## License
[MIT](https://choosealicense.com/licenses/mit/)