# doggo-api-wrapper

> A simple API wrapper for Dog API

Latest version **1.0.1** (published 2018-07-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install doggo-api-wrapper
pnpm add doggo-api-wrapper
yarn add doggo-api-wrapper
bun add doggo-api-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-07-06 |
| First published | 2018-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 139.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Julien Broyard |
| Maintainers | neosduswell |
| Keywords | api, api-wrapper, animals, dog, dog-api, dog-api-wrapper, fun |

## Links

- npm: https://www.npmjs.com/package/doggo-api-wrapper
- Repository: https://github.com/Julien-Broyard/doggo-api-wrapper
- Homepage: https://github.com/Julien-Broyard/doggo-api-wrapper#readme
- Issues: https://github.com/Julien-Broyard/doggo-api-wrapper/issues
- npm.io page: https://npm.io/package/doggo-api-wrapper

## Dependencies (1)

- [got](https://npm.io/package/got.md) ^8.3.1

## Recent versions

- 1.0.1 (latest) — 2018-07-06
- 1.0.0 — 2018-06-30
- 0.1.8 — 2018-06-28
- 0.1.7 — 2018-06-28
- 0.1.6 — 2018-06-13
- 0.1.5 — 2018-06-13
- 0.1.4 — 2018-06-13
- 0.1.3 — 2018-06-12
- 0.1.2 — 2018-06-12
- 0.1.1 — 2018-06-12
- 0.1.0 — 2018-06-12

## README

[![npm version](https://badge.fury.io/js/doggo-api-wrapper.svg)](https://badge.fury.io/js/doggo-api-wrapper)
[![npm](https://img.shields.io/npm/dm/doggo-api-wrapper.svg)](https://www.npmjs.com/package/doggo-api-wrapper)
[![Dependency Status](https://david-dm.org/pradel/doggo-api-wrapper.svg)](https://david-dm.org/pradel/doggo-api-wrapper)

# What is doggo-api-wrapper ?

[doggo-api-wrapper](https://www.npmjs.com/package/doggo-api-wrapper) is a simple API Wrapper for [DogAPI](https://dog.ceo/dog-api/)

---

# How to use it ?

First install the npm package
`npm i doggo-api-wrapper`
or
`yarn add doggo-api-wrapper`

Here is a basic exemple with getARandomDog()
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getARandomDog()
  .then(data => console.log(data))
  .catch(err => console.error(err))
```

Each methods of the doggo-api-wrapper returns a promise.

---

# List of all methods

`getAllDogsByBreed(breed)` returns an array of all the images from a breed
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getAllDogsByBreed('hound')
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getAllSubBreedImages(breed, subBreed)` returns an array of all the images from the sub-breed
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getAllSubBreedImages('hound', 'afgan')
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getARandomDog()` displays single random image from all dogs collection
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getARandomDog()
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getARandomDogFromBreed(breed)` returns a random dog image from a breed
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getARandomDogFromBreed('hound')
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getARandomSubBreedImage(breed, subBreed)` returnss a random image from a sub breed collection
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getARandomSubBreedImage('hound', 'afgan')
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getListOfAllBreeds()` list all breeds available
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getListOfAllBreeds()
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getMultipleRandomDogs(amount)` displays multiple random images from all dogs collection
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getMultipleRandomDogs(5)
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

`getSubBreedFromBreed(breed)` returns an array of all the sub-breeds from a breed
```javascript
const DogApi = require('doggo-api-wrapper');
const myDog = new DogApi();

myDog.getSubBreedFromBreed('hound')
  .then(data => console.log(data))
  .catch(err => console.error(err)) // Don't forget the catch it's important
```

---
_Source: https://npm.io/package/doggo-api-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._