Skip to content

just-doodle/roastra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤡 Roastra

A simple package to create roasts! Light weight, No Dependencies, Easy to use, Simple and Powerful. Also Funny! You can install this package from npm. Alternatively, you can use Web API

EXAMPLE
You are as dreadful as a goatish dozen of petty snake piss

🔨 Install npm

npm install roastra

⚙️ Usage

  1. Import the package:
import Roastra from "roastra";
  1. Initilize Roast Class with the parameters below
var roast = new Roastra({
  name: "Rocky",
});
  1. Getting response
  • Using callback roast.Get(<callback>)
roast.Get((data) => {
  console.log(data);
});

/* EXAMPLE OUTPUT
{
 sentance: 'Rocky is crazy as a dirty puddle of unwanted slug vomit',
 name: 'Rocky',
}
*/
  • Using return
var data = roast.Get();
console.log(data);

/* EXAMPLE OUTPUT
{
 sentance: 'Rocky is crazy as a dirty puddle of unwanted slug vomit',
 name: 'Rocky',
}
*/
Parameter Description type Required Default
name Name of the person you want to roast string false You
plural To set if name parameter is plural or not bool false false

🙏 Contribute

You can contribute to this project by adding words to words.json and Creating a PR.

💪 Support

Support this project by ⭐ Starring this Repo or buy me a coffee!

Buy Me A Coffee