# cats-js

> Wrapper for The Cat API

Latest version **1.0.2** (published 2017-06-16) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install cats-js
pnpm add cats-js
yarn add cats-js
bun add cats-js
```

## 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.2 |
| Published | 2017-06-16 |
| First published | 2017-06-16 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Salvage |
| Maintainers | saalvage |
| Keywords | cat, animal, cute |

## Links

- npm: https://www.npmjs.com/package/cats-js
- Repository: https://github.com/Saalvage/cats-js
- Homepage: https://github.com/Saalvage/cats-js#readme
- Issues: https://github.com/Saalvage/cats-js/issues
- npm.io page: https://npm.io/package/cats-js

## Dependencies (2)

- [request](https://npm.io/package/request.md) latest
- [xml2json](https://npm.io/package/xml2json.md) latest

## Recent versions

- 1.0.2 (latest) — 2017-06-16
- 1.0.1 — 2017-06-16
- 1.0.0 — 2017-06-16

## README

# cats-js

Node.js module that provides an API wrapper for [The Cat API](http://thecatapi.com/).

[![NPM](https://nodei.co/npm/cats-js.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/cats-js/)

## Features

* Get random cats
* Save & load cats you like
* 100% promise based
* JSON Output
* And more!


## Simple Example

``` javascript
var cats = require("cats-js");

var c = new cats();

c.get().then((cat) => {console.log(cat)});

```

## Output

``` javascript
{ images:
  { image: 
    { url: 'http://24.media.tumblr.com/tumblr_m34d23c4x21qhwmnpo1_500.jpg',
      id: '42p',
      source_url: 'http://thecatapi.com/?id=42p'
    }
  }
}
```

## More complex example

``` javascript
var cats = require("cats-js");

var c = new cats();

c.get({results_per_page: 10, type: "gif"}).then((cats) => {console.log(cats)});
```

## Output

``` javascript
{ images:
   { image:
      [ [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object],
        [Object] 
      ]
   }
}
```

### See docs/index.html for a detailed documentation!

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