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');
zalgo('some text')
banish('ŝ̜̩͇̼̥̼́̏͢o͎͊͜ḿ̛̩̳̖͕̞̩̭ͪe͖̺̣̹̺̋̀͛̽͝ ̖͍̭͓̯̠͑͑͢t̼̪̋͌͢eͯ̋͏͖͎͍̩̭̮x̢͚̄̾̀̈ͧ̓ͩ̚t̪ͫ͝')
const { chars } = require('awesome-zalgo/dist/chars');
console.log(chars);
Documentation
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