Animals-api NPM

Animals API

An API with a few simple, short easy to use methods for generating random animal pictures!

Installing and Testing

npm install animals-api --save

To test, open up the animals-api directory and use one of our tests (you can find in package.json the tests)

Example usage

const { getCat } = require('animals-api');
getCat('gif')
    .then((res) => console.log(res))
    .catch((error) => console.error(error));

Methods available

getBirb getCat getDog getDuck getFox getShibe

Contributing

Wanna contribute?

1) Fork the project! You could also preferably locally clone it so you can consistently lint. 2) Install dependencies via npm install (including eslint). 3) Make your changes, and lint them. 4) Make a pull request!

We are open to contributions such as adding servers we can access, so please do!

Notes

There are no .mp4 files in the database for getBirb() so please, do not try and get .mp4 files. The server for getCat() crashes often, so if you receive a 403 error then it is down. Both randomfox and randomduck also don't contain any PNG files, or GIFs.