Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sefinek/random-animals) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

» About this package «
😽 🦊

This package for npm returns random images of animals (cats, dogs, foxes etc.) from the official API.

📥 » Installation

npm install @sefinek/random-animals

🐈 » Usage

• Async/await example

const random = require('@sefinek/random-animals');

(async () => {
    const data = await random.cat();
    console.log(data.message);
})();

• Promise example

const random = require('@sefinek/random-animals');

random.fox().then(data => console.log(data.message));

😻 » Available functions

Name	Usage	Description
cat	`<random>.cat()`	Return random cats
dog	`<random>.dog()`	Return random dogs
fox	`<random>.fox()`	Return random foxes
fish	`<random>.fish()`	Return random fishes
alpaca	`<random>.alpaca()`	Return random alpacas
bird	`<random>.bird()`	Return random bird

version	`<random>.version()`	Return version of this module
apiVersion	`<random>.apiVersion()`	Return API version

📃 » Returned object

{
  "success": true,
  "status": 200,
  "info": { "category": "animals", "endpoint": "cat" },
  "message": "https://cdn.sefinek.net/images/animals/cat/neva-masquerade-cats-1375033-min.jpg"
}

🤝 » Help

If you encounter any issues or have questions, please open a new Issue on GitHub.

⭐ » Thank you

If you find this package useful, please consider giving it a star on GitHub page.

@sefinek/random-animals