# mattophobia

> Generate Mattophobia-like sentences

Latest version **1.1.3** (published 2020-10-06) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2020-10-06 |
| First published | 2019-05-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jack Baron |
| Maintainers | lolpants |

## Links

- npm: https://www.npmjs.com/package/mattophobia
- Repository: git@github.com:lolPants/mattophobia
- npm.io page: https://npm.io/package/mattophobia

## Recent versions

- 1.1.3 (latest) — 2020-10-06
- 1.1.2 — 2020-04-04
- 1.1.1 — 2019-11-21
- 1.1.0 — 2019-11-21
- 1.0.1 — 2019-07-11
- 1.0.0 — 2019-05-06

## README

# 💢 Mattophobia
[![NPM version](https://img.shields.io/npm/v/mattophobia.svg?maxAge=3600)](https://www.npmjs.com/package/mattophobia)
[![NPM downloads](https://img.shields.io/npm/dt/mattophobia.svg?maxAge=3600)](https://www.npmjs.com/package/mattophobia)
[![Build status](https://travis-ci.org/lolPants/mattophobia.svg)](https://travis-ci.org/lolPants/mattophobia)
[![Dependencies](https://img.shields.io/david/lolpants/mattophobia.svg?maxAge=3600)](https://david-dm.org/lolpants/mattophobia)
[![Coverage Status](https://coveralls.io/repos/github/lolPants/mattophobia/badge.svg?branch=master)](https://coveralls.io/github/lolPants/mattophobia?branch=master)

_Generate Mattophobia-like sentences_

## 💾 Installation
The package is on the NPM registry as `mattophobia`. Simply install it with your NPM client of choice.

## 🔧 Usage
First, import the module:
```js
const mattophobia = require('mattophobia')
```

`mattophobia()` is an [ES6 generator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator) that creates an [`IterableIterator<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
It returns an infinite series of Mattophobia strings.

### 💉 Options
You can pass in an object with options when instantiating the generator.

| Option | Type | Default | Description |
| - | - | - | - |
| `ings` | `string[]` | see `constants.ts` | Words ending with -ing for the generator |
| `swears` | `string[]` | see `constants.ts` | Profanity for the generator |
| `standalone` | `string[]` | see `constants.ts` | Standalone phrases for the generator |
| `minWords` | `number` | `4` | Minimum number of words per sentence |
| `maxWords` | `number` | `18` | Maximum number of words per sentence |
| `maxLength` | `number` | `140` | Maximum length of the string. Set to `< 1` for no limit. |

### 📝 Example
```js
// Import the module
const mattophobia = require('mattophobia')

// Limit to tweet length
const generator = mattophobia({ maxLength: 280 })
console.log(generator.next().value)
```

## 💙 Special Thanks
* [Python Fork](https://github.com/DerpyChap/mattophobia_says)

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