Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
An example of how to generate a random cat image!
// 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 errorAn example of how to generate a random joke!
// 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 errorAll the classes available for the current version.
Random - The random class includes all random things from advice to topic.
Util - The pacakge basic info and testing.
The class for getting information on the package or testing it.
author
String
The author(s) of the package.
description
String
The description of the package.
repo
Object
Current repository(s) of the package.
version
String
The version of the package.
Type
Description
any
Tests the package and retrieves an error(if any).
Type: ?
Returns: ``
Gives basic information on how to read the classes and stuff.
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.
Always keep in mind that notation is not always rigorous. There will be typos, misunderstandings, or context that will cause notation to differ from the usual meanings.
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>
Remember that this notation is not valid JavaScript, it is a shorthand to refer to a certain piece of code.
The class for generating random things such as cat images, dog images, jokes and much more!
Please make sure you do not instantiate this class. You can access it though const something = require('some-random-cat').Random
.getAdvice() STATICRandom method to generate an advice.
Type
Description
any
The string with the advice.
Returns: ``
.getCat() STATICRandom method to generate a random cat image.
Random method to generate a random dog image.
Random method to generate a random fact.
Random method to generate a random joke.
Random method to generate a meme.
Random method to generate a topic.
Type
Description
any
URL for the image.
Type
Description
any
URL for the image.
Type
Description
any
The string for the fact.
Type
Description
any
An object with the title, description and URL
Parameters
Type
Optional
Description
sub
String
❌
Parameters
Type
Optional
Description
number
Number
❌
Type
Description
any
The string with the topic.
Returns:
Returns:
Returns: ``
Returns:
Returns: ``
Returns: ``
Returns:``
The subreddit to get the meme from.
The length of the string.
This is the official documentation for some-random-cat. Docs version (v2.0)
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.
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!
Object-oriented
Speedy and efficient
Feature-rich
Easy
Beginner-Friendly
Flexible
Generate a random cat image:
200 weekly downloads
and... growing!
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