# heroesprofile-api

> A simple node js wrapper for the Heroes Profile API

Latest version **0.2.1** (published 2021-12-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install heroesprofile-api
pnpm add heroesprofile-api
yarn add heroesprofile-api
bun add heroesprofile-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-12-02 |
| First published | 2019-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.7.0 |
| Dependencies | 0 |
| Unpacked size | 30 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Astraeus- |
| Maintainers | astraeus- |

## Links

- npm: https://www.npmjs.com/package/heroesprofile-api
- Repository: https://github.com/Astraeus-/heroesprofile-api
- Homepage: https://github.com/Astraeus-/heroesprofile-api#readme
- Issues: https://github.com/Astraeus-/heroesprofile-api/issues
- npm.io page: https://npm.io/package/heroesprofile-api

## Recent versions

- 0.2.1 (latest) — 2021-12-02
- 0.2.0 — 2019-11-02
- 0.1.2 — 2019-10-14
- 0.1.1 — 2019-10-14
- 0.1.0 — 2019-10-14

## README

# heroesprofile-api
A simple node.js wrapper for the Heroes Profile API.

Website URL: https://api.heroesprofile.com/

## Getting Started
You will need to register for a plan at [Heroes Profile API](https://api.heroesprofile.com/register) to get a token.

### Install
Install the `heroesprofile-api` package from the NPM repository.
```bash
npm install heroesprofile-api --save
```

### Usage
```js
const HP = require('heroesprofile-api');
const api = new HP('token', 'json');

api.getHeroes({hero: 'Abathur'}).then((data) => {
    console.log(data);
});
```

The response format is either json or csv and defaults to json if not specified.
You can override this globally or per method.

Note: Not all methods support csv.

Some of the input gets validated against a list of [Heroes Profile constants](constants.js).

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