# incorrectquotesapi

> An API for ScatterPatter's Incorrect Quotes Generator (https://incorrect-quotes-generator.neocities.org/)

Latest version **2.1.1** (published 2021-03-10) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-03-10 |
| First published | 2021-03-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 68.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chromus |
| Maintainers | chromus |

## Links

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

## Dependencies (1)

- [leo-profanity](https://npm.io/package/leo-profanity.md) ^1.3.0

## Recent versions

- 2.1.1 (latest) — 2021-03-10
- 2.0.0 — 2021-03-08
- 1.0.0 — 2021-03-08

## README

<h1 align="center"><a href="https://www.npmjs.com/package/incorrectquotesapi" target="_blank">Incorrect Quotes API</a></h1></a></h1>

<h2 align="center">An API for generating random quotes from <a href="https://incorrect-quotes-generator.neocities.org/" target="_blank">ScatterPatter's Incorrect Quotes Generator</a></h2>
<br>
<div align="center">

[![npm](https://img.shields.io/npm/v/incorrectquotesapi)](https://www.npmjs.com/package/tinyscripts)
[![npm size](https://img.shields.io/bundlephobia/min/incorrectquotesapi)](https://www.npmjs.com/package/incorrectquotesapi)
</div>

## Install
```
npm i incorrectquotesapi
```
<br>

## Usage
```js
const randomQuote = require('incorrectquotesapi');

var people = 6;
// The number of people in the prompt
// NOTE: The current limit is 6

var names = [ 'Person 1', 'Person 2', 'Person 3', 'Person 4', 'Person 5', 'Person 6' ]
// An array of the names of people in the prompt
// If there are more names than people, it will return an error
// Defualts to ['Person A', 'Person B', 'Person C', 'Person D', 'Person E', 'Person F']

var clean = true // true/false
// Defualts to false
// NOTE: This does NOT prevent shipping of 2 users, just swearing and profanity

randomQuote(people, { names: names, clean: clean });
```
## Examples
```js
randomQuote(2);
// Person A: You know, I'm starting to regret showing you how that blender works. 
// Person B, drinking toast: Why do you say that?

randomQuote(4, { names: ['Bob', 'John', 'Robert', 'Sally']});
// Bob: Listen, I can explain... 
// John: You’re making $500,000 and you’re only gonna pay me $30,000?
// Robert: You’re getting 30 grand? I’m getting $1,000!
// Sally: You guys are getting paid?

randomQuote(7, { names: ['Bob', 'John', 'Robert', 'Sally']});
// TypeError: That is too many people! The limit is 6!
//  at incorrectquotesapi (<anonymous>:15:54)
//  at <anonymous>:1:1
```

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