LionelBergen / MundoScript

Node.js League/LoL/League Of Legends API wrapper, Focus is to be easy to use
33 stars 7 forks source link

LeagueAPIWrapper (Node.JS)

Simple Wrapper for all League Of Legends API methods

https://www.npmjs.com/package/leagueapiwrapper

Example get accountInfo object to be used in other methods:

#### ```javascript let LeagueAPI = require('leagueapiwrapper'); LeagueAPI = new LeagueAPI(leagueAPIKey, Region.NA); LeagueAPI.getSummonerByName('LeagueOfSausage') .then(function(accountInfo) { // do something with accountInfo console.log(accountInfo); }) .catch(console.error); ```

Get featured games, populated with DDRagon data

#### ```javascript LeagueAPI.initialize() .then(function(){ return LeagueAPI.getFeaturedGames() }) .then(function(data) { console.log(data); }) .catch(console.error); ```

Methods

initialize

#### ```javascript // Objects will now contain full objects, instead of id's. // E.G from 'mapId: 12' to 'mapObject: { id: 12 name: howlingAbyss ... }' LeagueAPI.initialize() .then() { // LeagueAPI returned objects will now have details from DDRagon API. }) .catch(console.error); ```

getDDragonLocalDataVersion

#### ```javascript // Gets the version of DDRagon that's included in this project. You can still use other versions, but it will require additional network calls to DDragon. // E.G from '11.1.1' LeagueAPI.getDDragonLocalDataVersion(); ```

setFullyLoadClasses(boolean)

#### ```javascript // Setting initialize() sets to true. // Must call initialize if setting this to true LeagueAPI.setFullyLoadClasses(false); ```

changeRegion(Region)

#### ```javascript // Changed Region for API calls LeagueAPI.changeRegion(Region.NA); ```

getThirdPartyCode(AccountObject)

#### ```javascript // Returns thirdPartyCode. Note: will 'Forbidden' if no thirdPartyCode is available for the accountInfo/accountId // Note: I don't have an accountId example that works here LeagueAPI.getThirdPartyCode(accountId) .then(function(data) { console.log(data); }) .catch(console.error); ```

getStatus()

#### ```javascript // Returns the status of the LeagueAPI endpoints LeagueAPI.getStatus() .then(console.log) .catch(console.error); ```

getFeaturedGames()

#### ```javascript // Returns the current featured games on League LeagueAPI.getFeaturedGames() .then(console.log) .catch(console.error); ```

getMatch(matchId) - Match-V5

#### ```javascript // matchId taken from a getMatchList call // Gets the Match object for the ID passed // Now Match-V5 supported // matchid has a different format in Match-V5. LeagueAPI.getMatch('NA1_4102250582') .then(console.log) .catch(console.error); ```

getMatchByTournament(matchId, tournamentCode)

#### ```javascript // Gets the Match object for the ID passed with tournamentCode. Note: I don't have an example tournament code LeagueAPI.getMatchByTournament(2970107953, tournamentCode) .then(console.log) .catch(console.error); ```

getMatchIdsByTournament(tournamentCode)

#### ```javascript // Gets the Match ids for the tournamentCode. Note: I don't have an example tournament code LeagueAPI.getMatchIdsByTournament(tournamentCode) .then(console.log) .catch(console.error); ```

getClash(accountObj)

#### ```javascript LeagueAPI.getClash(accountObj) .then(console.log) .catch(console.error); ```

getClashTournament()

#### ```javascript LeagueAPI.getClashTournament() .then(console.log) .catch(console.error); ```

getLeagueRanking(accountObject)

#### ```javascript LeagueAPI.getSummonerByName('LeagueOfDrMundo').then(function(accountObject) { LeagueAPI.getLeagueRanking(accountObject) .then(console.log) .catch(console.error); }); ```

getSummonerByName(summonerName)

#### ```javascript // Returns an accountObject which can be used in other methods, or view account information on LeagueAPI.getSummonerByName('LeagueOfDrMundo') .then(function(accountObject) { console.log(accountObject); }) .catch(console.error); ```

getActiveGames(accountObject)

#### ```javascript LeagueAPI.getSummonerByName('LeagueOfDrMundo') .then(function(accountObject) { // Gets active games. Will return 404 if not currently in an active game return LeagueAPI.getActiveGames(accountObject); }) .then(function(activeGames) { console.log(activeGames); }) .catch(console.error); ```

getMatchList(accountObject) - Match-V5

#### ```javascript //Now Match-V5 supported LeagueAPI.getSummonerByName('LeagueOfDrMundo') .then(function(accountObject) { // Gets match list for the account return LeagueAPI.getMatchList(accountObject); }) .then(function(activeGames) { console.log(activeGames); }) .catch(console.error); ```

getMatchTimeline(matchId) - Match-V5

#### ```javascript // Returns a timeline of the match //Now Match-V5 supported // matchid has a different format in Match-V5. LeagueAPI.getMatchTimeline('NA1_4102250582') .then(console.log) .catch(console.error); ```

getChampionMasteryTotal(accountObject)

#### ```javascript LeagueAPI.getSummonerByName('LeagueOfSausage') .then(function(accountObj) { // Returns the total champion master (sum of all champion mastery for all champions) return LeagueAPI.getChampionMasteryTotal(accountObj); }) .then(function(championMasteryTotal) { console.log(championMasteryTotal); }) .catch(console.error); ```

getChampionMastery(accountObject)

#### ```javascript LeagueAPI.getSummonerByName('LeagueOfDrMundo') .then(function(accountObj) { // Returns a list of every single champion played by the account, along with mastery details return LeagueAPI.getChampionMastery(accountObj); }) .then(function(championMasteryList) { console.log(championMasteryList); }) .catch(console.error); ```

getChampionMasteryByChampion(accountObject, championObj)

#### ```javascript const drMundoChampId = 36; const leagueOfDrMundoSummonerId = 'IE2WdICfZnhEWYPIBfHio7jxCeo1IFynclJAPquqENRrpeYK'; // Returns the championMastery details for the given account/accountId and champion/championId LeagueAPI.getChampionMasteryByChampion(leagueOfDrMundoSummonerId, drMundoChampId) .then(console.log) .catch(console.error); ```

getFreeChampionRotation()

#### ```javascript // Returns details for the current champion rotation. Initialize first for details on each champion LeagueAPI.getFreeChampionRotation() .then(console.log) .catch(console.error); ```

Disclaimer

MundoScript is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.

Feel free to make suggestions on features/etc.