easyquotes
v2.0.0
Published
Get random quotes, or quotes within a specific category with ease!
Downloads
3
Maintainers
Readme
What is easy-quotes?
easy-quotes is a simple dependency-less quotes manager with typescript support that can get you quotes submitted by many people with varying options for how much control you want to have over the formatting and type.
Installation
To install, run npm install easy-quotes
Usage
const eq = require('easy-quotes')
const inspirationalQuote = eq.getQuote({ categories: ['Inspirational'] })
Options
easy-quotes have multiple simple options to change what type of quote you want and how it is formatted
- categories - ['ALL' | 'Fun' | 'Inspirational' | 'Motivational' | 'Funny' | 'Exciting' | 'Rude'] (Defaults to ["ALL"])
- length - number (Defaults to 20)
- includesNSFW - boolean (Defaults to false)
- forProffessionalUse - boolean (Defaults to false)
- authorNameFormat - 'AllLong' | 'AllShort' | 'FirstLong MiddleShort LastLong' | 'FirstShort MiddleShort LastLong' (Defaults to 'AllLong')