Miss any of our Open RFC calls?Watch the recordings here! »

wow-realm-status

1.0.6 • Public • Published

wow-realm-status

NPM Build Status Maintainability XO code style

Easily fetch info about the World of Warcraft realms.

Install

npm install wow-realm-status

Usage

const {fetchRealm} = require('wow-realm-status');
 
fetchRealm('us', 'ragnaros')
    .then(realm => console.log(realm));
//=> {
//  name: 'Ragnaros',
//  slug: 'ragnaros',
//  locale: 'es-MX',
//  timezone: 'CDT',
//  online: true,
//  type: 'normal',
//  population: 'full'
//}

fetchRealm(region, realm[, classic])

Returns a JSON object containing the realm data.

region

Type: string

realm

Type: string

classic

Type: boolean
Default: false

fetchRealms(region[, classic])

Returns an array of JSON objects with the realms for that region.

region

Type: string

classic

Type: boolean
Default: false

Realm data

Each realm is represented as a JSON object with the following properties:

name

Type: string

slug

Type: string

locale

Type: string

Locale of the realm, formatted as a IETF BCP 47 language tag.

timezone

Type: string

online

Type: boolean

type

Type: string

Possible values are: normal, pvp, rp, rppvp.

population

Type: string

Current population of the realm.
Possible values are: very-low, low, medium, high, full

Contributing

Contributions are always welcome! Please run npm test before hand to ensure everything is ok.

Support

If you use this package please consider starring it :)

Related

Install

npm i wow-realm-status

DownloadsWeekly Downloads

3

Version

1.0.6

License

MIT

Unpacked Size

5.8 kB

Total Files

7

Last publish

Collaborators

  • avatar