# zirin

> Efficient uwuifier for text.

Latest version **1.1.1** (published 2021-02-12) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install zirin
pnpm add zirin
yarn add zirin
bun add zirin
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2021-02-12 |
| First published | 2021-02-12 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | MelnCat |
| Maintainers | williamjs |
| Keywords | uwuify, uwu, owo, uwu-text, uwuification |

## Links

- npm: https://www.npmjs.com/package/zirin
- npm.io page: https://npm.io/package/zirin

## Dependencies (1)

- [furry](https://npm.io/package/furry.md) ^0.2.0

## Recent versions

- 1.1.1 (latest) — 2021-02-12
- 1.1.0 — 2021-02-12
- 1.0.5 — 2021-02-12
- 1.0.4 — 2021-02-12
- 1.0.3 — 2021-02-12
- 1.0.2 — 2021-02-12
- 1.0.1 — 2021-02-12

## README

# zirin.js

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

Supports optional fully customizable emoticon addition.

## Functions

<dl>
<dt><a href="#uwuify">uwuify(str, [options])</a> ⇒ <code>string</code></dt>
<dd></dd>
<dt><a href="#uwuifyCurry">uwuifyCurry(opts)</a> ⇒ <code>function</code></dt>
<dd></dd>
</dl>

## Typedefs

<dl>
<dt><a href="#UwUOptions">UwUOptions</a> : <code>Object</code></dt>
<dd><p>Options for uwuification.</p>
</dd>
</dl>

<a name="uwuify"></a>

## uwuify(str, [options]) ⇒ <code>string</code>
**Returns**: <code>string</code> - The uwuified string.  

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | The string to uwuify. |
| [options] | [<code>UwUOptions</code>](#UwUOptions) | The options for the uwuification. |

<a name="uwuifyCurry"></a>

## uwuifyCurry(opts) ⇒ <code>function</code>
**Returns**: <code>function</code> - A curried function.  

| Param | Type | Description |
| --- | --- | --- |
| opts | [<code>UwUOptions</code>](#UwUOptions) | The options. |

<a name="UwUOptions"></a>

## UwUOptions : <code>Object</code>
Options for uwuification.

**Properties**

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

---
_Source: https://npm.io/package/zirin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._