zirin.js
Efficient module for converting readable text into "uwuified" text.
Supports optional fully customizable emoticon addition.
Functions
-
uwuify(str, [options]) ⇒
string
-
uwuifyCurry(opts) ⇒
function
Typedefs
-
UwUOptions :
Object
-
Options for uwuification.
string
uwuify(str, [options]) ⇒ Returns: string
- The uwuified string.
Param | Type | Description |
---|---|---|
str | string |
The string to uwuify. |
[options] | UwUOptions |
The options for the uwuification. |
function
uwuifyCurry(opts) ⇒ Returns: function
- A curried function.
Param | Type | Description |
---|---|---|
opts | UwUOptions |
The options. |
Object
UwUOptions : 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. |