warcraft.js v0.7.1
About
warcraft.js was developing for CyberEngine. And now, she is open source! warcraft.js connecting Blizzard API and getting some in game data for you.
Installation
warcraft.js requires Node.js latest version to run.
$ npm i warcraft.js -S
or
$ yarn add warcraft.js
Usage
// Async version
const response = await warcraft.data.mythickeystone.leaderboard('dungeon-name', 'realm', 'region', 'period');
const response = await warcraft.data.mythickeystone.leaderboard('dungeon-name');
// Normal version
warcraft.community.guild.members('guild-name', 'region').then(response => {
console.log(response);
});
/* or */
warcraft.community.guild.multi('guild-name', 'members', 'news').then(response => {
console.log(response);
}); // if you have a config file.
Technology
warcraft.js uses a number of open source projects to work properly:
- Node.JS - warcraft.js uses this powerful programming language.
- VScode - We're highly recommending this awesome code editor.
And of course warcraft.js itself is open source with a public repository on GitHub.
Plugins
warcraft.js is currently extended with the following plugins. Instructions on how to use them in your own application are linked below.
Plugin | README |
---|---|
@types/node | plugins/definitelytyped/README.md |
Eslint | plugins/eslint/README.md |
Request | plugins/request/README.md |
Request-Promise | plugins/request-promise/README.md |
Semantic Versioning
We're using SemVer for this project.
Development
Want to contribute? Great!
warcraft.js uses eslint for stable developing. Make a change in your file and instantanously see your updates!
Open your favorite Terminal and run these commands.
$ git clone <url>
$ cd <cloned_folder_name>
$ npm i
$ npm test
Our Contributors
- Yankı Küçük - Twitter
And you can see also all contributors here.
License
Aphace 2.0
6 years ago