zirin.js

Efficient module for converting readable text into "uwuified" text.

Supports optional fully customizable emoticon addition.

Functions

Typedefs

uwuify(str, [options]) ⇒ string

Returns: string - The uwuified string.

| Param | Type | Description | | --- | --- | --- | | str | string | The string to uwuify. | | [options] | UwUOptions | The options for the uwuification. |

uwuifyCurry(opts) ⇒ function

Returns: function - A curried function.

| Param | Type | Description | | --- | --- | --- | | opts | UwUOptions | The options. |

UwUOptions : Object

Options for uwuification.

Properties

| Name | Type | Description | | --- | --- | --- | | enableEmoticons | boolean | Whether to enable the additions of emoticons. | | emoticons | Array.<string> | The emoticons to add if enableEmoticons is enabled. | | emoticonChance | number | The chance for an emoticon to appear. Must be a number from 0 to 1. | | enableStutter | boolean | Whether stuttering is enabled. | | stutterChance | number | The chance for a stutter. Must be a number from 0 to 1. |