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

Code

// This snippet uses some-random-cat version 2.0

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

Output

Available Classes

• Random - The random class includes all random things from advice to topic.

• Util - The pacakge basic info and testing.

Go to

Properties

.info STATIC

The general information for the package.

Methods

.test() STATIC

Random method to generate an advice.

Code

// This snippet uses some-random-cat version 2.0

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

Output

Methods

.getAdvice() STATIC

Random method to generate an advice.

.getCat() STATIC

Random method to generate a random cat image.

.getDog() STATIC

Random method to generate a random dog image.

.getFact() STATIC

Random method to generate a random fact.

.getJoke() STATIC

Random method to generate a random joke.

.getMeme(sub) STATIC

Random method to generate a meme.

.getString(number) STATIC

.getTopic() STATIC

Random method to generate a topic.

Throughout the whole SomeRandomCat documentation or in the support server, you may see notation very often. To help you understand those, we will be going over a few common types of them.

Classes

Some common notations are used to refer to a class or the properties, methods, or events of a class. There are many variations on these notations, and they are very flexible depending on the person, so use your best judgement when reading them. For example, if you are given a text <Random>, it means an instance of the class Random. It is telling you to replace it with your own instance that you have made, but in our case, it is STATIC which means there is no hustle and bustle of instantiating it.

The notation Class#foo refers to a property called foo in the class Class. However in the case of STATIC properties you write it as Class.foo

To write an event, you can write it as <Class>#<property>:<event>