awesome-zalgo v1.0.5

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

Kind: Type Properties

zalgo(text, options) ⇒ string

Kind: function

banish(purgeable) ⇒ string

Kind: function

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