Skip to content

A Node.js module that returns quotes randomly or filtered based on input text/string. Input is considered case insensitive.

License

Notifications You must be signed in to change notification settings

naman1303/find-quote

Repository files navigation

Quote Finder  Rainbow

Django Unchained

Build Status Codacy Badge Dependency Status Downloads Install Size Last Commit Known Vulnerabilities


Find your favorite quote using a search string or simply enjoy a nice one generated randomly.


Quotes from   William Shakespeare  F.R.I.E.N.D.S  Harry Potter  Game of Thrones  and many more...

** What’s new in latest version? - Added Rainbow styled display of quotes.


A Node.js module to fetch quotes - generic, from movies and from series. If an input text/string is provided the quote having that word would be returned otherwise a random quote. Input is case insensitive.

There are variety of functions to fetch quotes. Examples given below.

Installation

npm install find-quote --save

Usage

const quote = require('find-quote');

console.log(quote.getQuote('Imagination')); 
// Output is filtered : Imagination is more important than knowledge.

console.log(quote.getQuote('FUTURE')); 
// Output is case insensitive : I never think of the future

console.log(quote.getQuote()); 
// Output is random quote : The mind that is anxious about future events is miserable.

console.log(quote.getQuoteWithAuthor('knowledge'));
// Output is an object: { quote: 'Imagination is more important than knowledge.', author: 'Albert Einstein' }

console.log(quote.getMovieQuote());
// Output is random movie quote : May the Force be with you.

console.log(quote.getQuoteWithMovieName('Death'));
// Output is an object: { quote: 'Remember that all worlds draw to an end and that noble death is a treasure which no one is too poor to buy.', movie: 'The Chronicles of Narnia' }

console.log(quote.getSeriesQuote());
// Output is random series quote : When you play the Game of Thrones, you win or you die.

console.log(quote.getQuoteWithSeriesName('brave'));
// Output is an object: { quote: 'The only time a man can be brave is when he’s afraid.', series: 'Game of Thrones' }

Rainbow Display

chalk-animation package has been used to display a quote in Rainbow style. No explicit console or print is needed, just call the functions as mentioned below.

Expected Output

** Limitation - Last display output overwrites all previous displays.

const quote = require('find-quote');
quote.displayQuote();
quote.displayMovieQuote();
quote.displaySeriesQuote();

Note: You can also pass below animations (supported by chalk-animation) explicitly as input:

1. rainbow  2. pulse   3. glitch   4. radar   5. neon   6. karaoke

For example:  quote.displayQuote('glitch');

Reference

I have referred to this repository for the quotes.

Contribution

If you wish to add more quotes, you can send pull requests. Suggestions are welcome for any sort of enhancements or improvements.

About

A Node.js module that returns quotes randomly or filtered based on input text/string. Input is considered case insensitive.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published