api.md

Functions

html2unicode(html) ⇒ Promise.<String>

Turns an html string into an unicode string.

transform()

Transforms a text according to the given options

html2unicode(html) ⇒ Promise.<String>

Turns an html string into an unicode string.

Kind: global function
Returns: Promise.<String> - an unicode string.

Param	Type	Description
html	string	the source html

Example

await html2unicode("Hello, <b>world</b> !");
    // --> "Hello, 𝘄𝗼𝗿𝗹𝗱!"

transform()

Transforms a text according to the given options

Kind: global function
Example

transform("world", {bold: true});
     // --> "𝘄𝗼𝗿𝗹𝗱"

Example

transform("world", {underline: true});
     // --> "w̲o̲r̲l̲d̲"

Example

transform("world", {bold: true, italics: true});
     // --> "𝙬𝙤𝙧𝙡𝙙"

Example

transform("n", {sup: true});
     // --> "ⁿ"

Example

transform("text", {mono: true});
     // --> "𝚝𝚎𝚡𝚝"