# Introduction

[![NPM](https://nodei.co/npm/some-random-cat.png)](https://nodei.co/npm/some-random-cat/)

![Total Downloads](https://img.shields.io/npm/dt/some-random-cat?style=flat\&label=Downloads) <img src="https://img.shields.io/discord/772129415005470740?color=%237289DA&#x26;label=Discord&#x26;logo=Discord&#x26;style=flat" alt="Discord" data-size="original"> ![npm](https://img.shields.io/npm/v/some-random-cat?style=flat) ![NPM](https://img.shields.io/npm/l/some-random-cat?style=flat) ![GitHub Repo stars](https://img.shields.io/github/stars/aktindo/some-random-cat?style=flat)

Written in JavaScript <img src="https://3133094034-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNWYMnKi7gt-dpc7vrC%2F-MOiwhh2abKGYf3kUFLN%2F-MOixZwhXPxRNgeryyPq%2Fjavascript.svg?alt=media&#x26;token=0e1b735c-a18b-4b57-8488-0c52cc45bb25" alt="" data-size="line"> \
Edited in Visual Studio Code <img src="https://3133094034-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MNWYMnKi7gt-dpc7vrC%2F-MOiienW-VxSYnQt-SH0%2F-MOiprEHeZRI3ieprYEk%2Fvisualstudiocode.svg?alt=media&#x26;token=7dfdadb8-c8a1-4e68-b060-077461b201d2" alt="" data-size="line">&#x20;

Hi there, this is the insider build documentation that has new features documented! See the dev branch in GitHub for the same.

## 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:

```javascript
const somethingRandom = require('some-random-cat').Random //Import the package
somethingRandom.getCat()
.then(res => {
    console.log(res)
    return
}) // Get the result
.catch(e => {
    console.error(e)
    return
}) // Catch the error
```

## Statistics

* 600+ downloads
*

{% content-ref url="docs/classes/random" %}
[random](docs/classes/random)
{% endcontent-ref %}
