# 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) ![Discord](https://img.shields.io/discord/772129415005470740?color=%237289DA\&label=Discord\&logo=Discord\&style=flat) ![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)

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:

```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

* 200 weekly downloads
* and... growing!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://somerandomcat.js.org/undefined.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.