wow-realm-status

Easily fetch info about the World of Warcraft realms.

• Install
• Usage
• Realm data
• Contributing
• Support
• Related

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[, version="retail"])

Returns a JSON object containing the realm data.

region

Type: string

realm

Type: string

classic

Type: boolean
Default: "retail"

fetchRealms(region[, version])

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

region

Type: string

version

To specify the game version to fetch.

Type: string
Supported values: "retail", "classic", "bc"
Default: "retail"

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

• wow-realm-status-cli - CLI version of this library.