/league-typenode

Node.js + TypeScript wrapper for the League of Legends API

Primary LanguageTypeScriptMIT LicenseMIT

league-typenode

NPM version Build Status Coverage Status devDependency Status

Simple TypeScript + Node.js wrapper for the official Riot Games' League of Legends API using league-typedef definitions.

Installing

  • Install npm with Node.js
  • Run npm install in the project's root directory

Building

  • Run npm run build in the project's root directory to build the sources and test files.

Usage

// Import the wrapper
import * as leaguetn from 'league-typenode';

// Instanciate it
var tn: leaguetn.LeagueTypenode = new leaguetn.LeagueTypenode('your-api-key', false);

// Use it with callbacks
tn.getSummonerByNames("euw", "protectator", (error, summoners) => {
    if (error) {
        throw error;
    }
    console.log(summoners["protectator"].id);
});

Testing

  • Run npm test in the project's root directory to run the tests locally.

License

league-typenode is distributed under The MIT License.