# wow-armory.js

> A Node.js library for the new World of Warcraft Community Platform API.

Latest version **1.0.8** (published 2018-11-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install wow-armory.js
pnpm add wow-armory.js
yarn add wow-armory.js
bun add wow-armory.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.8 |
| Published | 2018-11-26 |
| First published | 2018-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | Shane Jeffery |
| Maintainers | 1rm |

## Links

- npm: https://www.npmjs.com/package/wow-armory.js
- npm.io page: https://npm.io/package/wow-armory.js

## Dependencies (3)

- [qs](https://npm.io/package/qs.md) ^6.6.0
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [dotenv](https://npm.io/package/dotenv.md) ^6.1.0

## Recent versions

- 1.0.8 (latest) — 2018-11-26
- 1.0.7 — 2018-11-26
- 1.0.6 — 2018-11-26
- 1.0.5 — 2018-11-26
- 1.0.3 — 2018-11-26
- 1.0.2 — 2018-11-26
- 1.0.1 — 2018-11-26
- 1.0.0 — 2018-11-26

## README

## WoW-Armory.js

WoW-Armory.js is a simple Node.js library for fetching data from the World of Warcraft Community Platform API. This library works with the new Blizzard Battle.net Developer Portal and the OAuth authentication that Blizzard has decided to employ.

Given that I myself am not a big fan of Passport (it is bloated for the basic need of requesting data from an API), I created this library to just make a simple [Axios](https://github.com/axios/axios) request per function call with a unique access token per call.

### Installation

Install `wow-armory.js` and save to your package.json dependencies in one easy step:

```
$ npm install wow-armory.js --save
```

### Usage

In wherever you are setting your environment variables, you will need to add 3 new ones that should get passed into the constructor you see in the below code sample:

`BNET_ID` -- Will come from your developer account profile on the Battle.net Developer Portal
`BNET_SECRET` -- Will come from your developer account profile on the Battle.net Developer Portal
`BNET_REGION` -- What region your Battle.net resides.

Code sample:

```javascript
const Armory = require('wow-armory.js');
const armoryClass = new Armory('bnet_id', 'bnet_secret', 'bnet_region');

armoryClass.getCharacter('region', 'server', 'character', 'optional_query_params')
    .then((characterInfo) => {
        console.log(characterInfo);
    });
```

### Todos

 - Write Jest Tests
 - Add support for more character endpoints -- Challenge Modes, Appearances, etc.
 - Add support for other APIs -- Guild Profile, Challenge Mode, Auction API, Boss API, etc.

### License

MIT

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