1.0.0 • Published 8 years ago

node-gg v1.0.0

Weekly downloads
4
License
MIT
Repository
github
Last release
8 years ago

championgg-api-node

A node module wrapper for the Champion.GG API

installation

npm install node-gg

usage

First, instantiate the wrapper with your api key

var GG = require('node-gg');
var gg = GG.init('YOUR_KEY');

Then you gain access to all current endpoints of the API! All but initialization require a callback function and some also require either role or champion_name, along with an optional object with ...options. These options are passed as query string params and are page and limit

The methods are:

MethodParameters
.initapi_key
.statistics.allcb
.statistics.role.specific.improvement.mostrole, options, callback
.statistics.role.specific.improvement.leastrole, options, callback
.statistics.role.specific.winning.mostrole, options, callback
.statistics.role.specific.winning.leastrole, options, callback
.statistics.role.specific.performance.bestrole, options, callback
.statistics.role.specific.performance.leastrole, options, callback
.statistics.champs.specificname, callback
.statistics.champs.general.winning.mostoptions, callback
.statistics.champs.general.winning.leastoptions, callback
.statistics.champs.general.played.mostoptions, callback
.statistics.champs.general.played.leastoptions, callback
.statistics.champs.general.banned.mostoptions, callback
.statistics.champs.general.rated.bestoptions, callback
.statistics.champs.general.rated.worstoptions, callback
.champions.allcallback
.champions.data.specificname, callback
.champions.data.generalname, callback
.champions.skills.infoname, callback
.champions.skills.order.popularname, callback
.champions.skills.order.winningname, callback
.champions.items.starting.popularname, callback
.champions.items.starting.winningname, callback
.champions.items.finished.winningname, callback
.champions.items.finished.popularname, callback
.champions.runes.winningname, callback
.champions.runes.popularname, callback
.champions.matchups.generalname, callback
.champions.matchups.specificname, enemyName, callback

tests

npm test

contributing

Feel free to contribute, let's just try to keep it readable :)

Release History

  • 1.0.0 Initial release