erickang21/awesome-zalgo

Invoke and banish the power of the Zalgo Monster

Awesome Zalgo

Unleash and banish the Zalgo Monster!

---

This library uses the Zalgo character set from Acme::Zalgo

Install

Install with yarn:

$ yarn add awesome-zalgo

Usage

const { zalgo, banish } = require('awesome-zalgo');
// Or for babel / typescript:
// import { zalgo, banish } from 'awesome-zalgo';
// Zalgo is also available as default import. For example
// import zalgo, { banish } from 'awesome-zalgo';

// Zalgo usage
zalgo('some text')


// > ŝ̜̩͇̼̥̼́̏͢o͎͊͜ḿ̛̩̳̖͕̞̩̭ͪe͖̺̣̹̺̋̀͛̽͝ ̖͍̭͓̯̠͑͑͢t̼̪̋͌͢eͯ̋͏͖͎͍̩̭̮x̢͚̄̾̀̈ͧ̓ͩ̚t̪ͫ͝



// Banish usage
banish('ŝ̜̩͇̼̥̼́̏͢o͎͊͜ḿ̛̩̳̖͕̞̩̭ͪe͖̺̣̹̺̋̀͛̽͝ ̖͍̭͓̯̠͑͑͢t̼̪̋͌͢eͯ̋͏͖͎͍̩̭̮x̢͚̄̾̀̈ͧ̓ͩ̚t̪ͫ͝')


// > some text

// To log all the supported chars use:
const { chars } = require('awesome-zalgo/dist/chars');
console.log(chars);

Documentation

ZalgoOptions : ZalgoOptions

Options for the Zalgo

Kind: Type Properties

Name	Type	Description
[up]	boolean	Whether the zalgo should go up
[middle]	boolean	Whether the zalgo should go in the middle
[down]	boolean	Whether the zalgo should go downards
[size]	"mini"

zalgo(text, [options]) ⇒ string

Zalgolize any text

Kind: function

Param	Type	Description
text	string	Input text to zalgolize
[options]	ZalgoOptions	Options for the Zalgo

banish(purgeable) ⇒ string

De-zalgolize any text

Kind: function

Param	Type	Description
purgeable	string	Text to remove zalgo from

---

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

License

Copyright © 2019, Favna. Released under the MIT License.

Buy me a donut

This project is open source and always will be, even if I don't get donations. That said, I know there are people out there that may still want to donate just to show their appreciation so this is for you guys. Thanks in advance!

I accept donations through PayPal, BitCoin, Ethereum and LiteCoin. You can use the buttons below to donate through your method of choice

Donate With	QR	Address
		Donate with PayPal
		1E643TNif2MTh75rugepmXuq35Tck4TnE5
		0xF653F666903cd8739030D2721bF01095896F5D6E
		LZHvBkaJqKJRa8N7Dyu41Jd1PDBAofCik6