Introduction

This is the official documentation for some-random-cat. Docs version (v2.0)

Installation

To install the package, you would have to make sure that node.js is installed on your machine. After that, you can simply do npm i some-random-cat in the terminal where you want to install the package or npm i some-random-cat -g to install it globally.

About

I saw that there were not many good packages for generating random stuff. So I decided to make one.
A very suitable API to generate random images of cats, dogs and random jokes, facts... A lot more!

Why?

• Object-oriented
• Speedy and efficient
• Feature-rich
• Easy
• Beginner-Friendly
• Flexible

Example

Generate a random cat image:

const SomeRandomCat = require('some-random-cat').Random;
SomeRandomCat.getCat() // Function for generating cat
.then(res => {
    console.log(res)
    return
})
.catch(e => {
    console.error(e)
    return
});

Contributing

To contribute in this package, simple open a pull request in the github repository. When all the checks for your request have been passed, we can merge it into the main branch.

Statistics

• 200 weekly downloads
• and... growing!

Support

Join the support server here

Documentation

📖 The official documentation is now available here