Fetch information about World of Warcraft realms
npm install wow-realm-statusEasily fetch info about the World of Warcraft realms.
- Install
- Usage
- Realm data
- Contributing
- Support
- Related
``bash`
npm install wow-realm-status
`js
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'
//}
`
Returns a JSON object containing the realm data.
#### region
Type: string
#### realm
Type: string
#### classic
Type: boolean"retail"
Default:
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"retail"
Supported values: , "classic", "bc""retail"
Default:
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
Contributions are always welcome! Please run npm test` before hand to ensure everything is ok.
If you use this package please consider starring it :)
* wow-realm-status-cli - CLI version of this library.