Only this pageAll pages
Powered by GitBook
1 of 10

main

Loading...

Examples

Loading...

Loading...

Documentation

Loading...

Loading...

Loading...

Misc

Loading...

Random Cat Image

An example of how to generate a random cat image!

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

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!

  • Object-oriented

  • Speedy and efficient

  • Feature-rich

Generate a random cat image:

  • 200 weekly downloads

  • and... growing!

Random Joke

An example of how to generate a random joke!

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

Note: This returns a default JavaScript Object.
Easy
  • Beginner-Friendly

  • Flexible

  • 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

    Why?

    Example

    Statistics

    Random

    Reading Notation

    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.

    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>

    Remember that this notation is not valid JavaScript, it is a shorthand to refer to a certain piece of code.

    Classes

    All the classes available for the current version.

    Available Classes

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

    • Util - The pacakge basic info and testing.

    Go to

    Random

    Util

    The class for getting information on the package or testing it.

    The general information for the package.

    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.

    Random method to generate an advice.

    Type

    Description

    any

    Tests the package and retrieves an error(if any).

    PARAMETER

    TYPE

    DESCRIPTION

    author

    Please make sure you do not instantiate this class. You can access it though const something = require('some-random-cat').Random

    Properties

    .info STATIC

    String

    Type: ?

    Methods

    .test() STATIC

    Returns: ``

    Random

    The class for generating random things such as cat images, dog images, jokes and much more!

    Random method to generate an advice.

    Object
    Promise<Pending>
    Random method to generate a random cat image.

    Type

    Description

    any

    URL for the image.

    Random method to generate a random dog image.

    Type

    Description

    any

    URL for the image.

    Random method to generate a random fact.

    Type

    Description

    any

    The string for the fact.

    Random method to generate a random joke.

    Type

    Description

    any

    An object with the title, description and URL

    Random method to generate a meme.

    Parameters

    Type

    Optional

    Description

    sub

    String

    ❌

    The subreddit to get the meme from.

    Parameters

    Type

    Optional

    Description

    number

    Number

    ❌

    The length of the string.

    Random method to generate a topic.

    Type

    Description

    any

    The string with the topic.

    Type

    Description

    any

    The string with the advice.

    Please make sure you do not instantiate this class. You can access it though const something = require('some-random-cat').Random

    Methods

    .getAdvice() STATIC

    Returns: Promise<Pending>``

    .getCat() STATIC

    Returns:

    .getDog() STATIC

    Returns:

    .getFact() STATIC

    Returns: ``

    .getJoke() STATIC

    Returns:

    .getMeme(sub) STATIC

    Returns: ``

    .getString(number) STATIC

    Returns: ``

    .getTopic() STATIC

    Returns:``

    Promise<Pending>
    Promise<Pending>
    Promise<Pending>
    Promise<Pending>
    Promise<Pending>
    Promise<Pending>
    Promise<Pending>
    Discord
    npm
    GitHub Repo stars
    NPM
    Total Downloads
    NPM