Skip to content

This is a primary version of a Quote API, which gives quotes from database to the user according to the request made to the API.

License

Notifications You must be signed in to change notification settings

regal-rahul/quote-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quote Library

Installation

Install quote-library with npm

  npm install quote-library

Features

  • This Quote library is a classic combination of 1500+ different types of Quotes.
  • Random Quote - It can be used to generate a random Quote from the collection.
  • Quote by Author - You can find Quote by specifying Author name.
  • Quote by Keyword - You can find Quote by any particular keyword.

Usage

import quotes from "quote-library";
console.log(quotes.allQuote());
var quotes = require("quote-library");
console.log(quotes.allQuote());

Use of Required Functions

import randQuote from "quote-library";
or;
var randQuote = require("quote-library");
console.log(randQuote.randomQuote());
import qba from "quote-library";
or;
var qba = require("quote-library");
console.log(qba.quoteByAuthor("Buddha", count));
import qbk from "quote-library";
or;
var qbk = require("quote-library");
console.log(qbk.quoteByKeyword("Success", count));

You can pass number in the place of count to fetch specific number of quotes.

If Quotes are not available in specified quantity according to count. You will get all the matched count of Quotes.

Functions

Function Name Returns Arguments Description
allQuotes() Array of Objects null Returns all quotes data including "quoteText", "quoteAuthor".
randomQuote() Object ( single ) null Returns a Random quote from the quotes library.
quoteByAuthor() Array of Objects string, number(optional) Returns all matched quotes by Author name, and specified number of matched result.
quoteByKeyword() Array of Objects string, number(optional) Returns all matched quotes by keyword, and specified number of matched result .

NOTE

This Quote library is currently offering approximately 1500+ Quotes collection. You might not find a quote you are looking for because of the limited collection of data.

The Quotes collection might increase with future updates.

Examples

var quotes = require("quote-library");
console.log(quotes.quoteByAuthor("Buddha", 2)); // second parameter is optional

/**
[
    {
      quote: 'What you are is what you have been. What you�ll be is what you do now.',
      author: 'Buddha'
    },
    { quote: 'What we think, we become.', author: 'Buddha' }
]
**/
var quotes = require("quote-library");
console.log(quotes.randomQuote());

/**
{
    quoteText: 'We never live; we are always in the expectation of living.',
    quoteAuthor: 'Voltaire'
}
**/
var quotes = require("quote-library");
console.log(quotes.quoteByKeyword("success", 2)); // second parameter is optional

/**
[
    {
      quote: 'One fails forward toward success.',
      author: 'Charles Kettering'
    },
    {
      quote: 'The path to success is to take massive, determined action.',
      author: 'Tony Robbins'
    }
]
**/

Upcoming Feature Update

  • A huge collection of amazing facts and jokes will be added. UNDER DEVELOPMENT

🔗 Useful Links

GITHUB REPOSITORY

NPM PACKAGE

License

License: MIT

Free to use, made by Regal-Rahul