incorrectquotesapi

Incorrect Quotes API

An API for generating random quotes from ScatterPatter's Incorrect Quotes Generator

Install

npm i incorrectquotesapi

Usage

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

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