tsm-redis-node v1.1.4

tsm-redis-node

Node client for TSM static data

Usage

var tsm_redis = require('tsm-redis')(options);

The options object contains redis connection info: port, host and password. If no object is passed, it'll try to connect to localhost in the default port without auth.

The client exposes several methods to retrieve static data. It can be extended to other games, but right now it's only for LoL. The methods are:

tsm_redis.lol.champions.get
tsm_redis.lol.champions.getAll
tsm_redis.lol.champions.getTypes
tsm_redis.lol.champions.getUnion
tsm_redis.lol.champions.getIntersection

tsm_redis.lol.runes.get
tsm_redis.lol.runes.getAll
tsm_redis.lol.runes.getTypes
tsm_redis.lol.runes.getUnion
tsm_redis.lol.runes.getIntersection
tsm_redis.lol.runes.getQuintessences
tsm_redis.lol.runes.getMarks
tsm_redis.lol.runes.getGlyphs
tsm_redis.lol.runes.getSeals

tsm_redis.lol.masteries.get
tsm_redis.lol.masteries.getAll
tsm_redis.lol.masteries.getTypes
tsm_redis.lol.masteries.getUnion
tsm_redis.lol.masteries.getIntersection
tsm_redis.lol.masteries.getFerocity
tsm_redis.lol.masteries.getCunning
tsm_redis.lol.masteries.getResolve

tsm_redis.lol.summoners.get
tsm_redis.lol.summoners.getAll

tsm_redis.lol.items.get
tsm_redis.lol.items.getAll
tsm_redis.lol.items.getTypes
tsm_redis.lol.items.getUnion
tsm_redis.lol.items.getIntersection

All the get methods recieve an identifier for the data being looked for. Champions accepts id, name or key. Items accept id. Summoners accept id, key or name. Runes accept id. Masteries accept id.

tsm_redis.lol.champions.get('Jinx', function (err, data) { console.log(data); });

getAll returns all data for that particular group, so tsm_redis.lol.champions.getAll would return all static data for all champions.

tsm_redis.lol.champions.getAll(function (err, data) { console.log(data); });

getTypes returns the categories a particular group of elements has, based on what Riot gives us. This means champions have fighter, melee, assassin, etc categories, as masteries have cunning, resolve and ferocity. So on and so forth for the other categories.

tsm_redis.lol.champions.getType(function (err, data) { console.log(data); });

getUnion returns a union of data based on the given types. So passing ['fighter', 'melee'] will return all champions that are classified as melee or fighter.

tsm_redis.lol.champions.getUnion(['fighter', 'melee'], function (err, data) { console.log(data); });

getIntersection returns the intersection of two data classifications. Passing ['fighter', 'melee'] will return all champions that are classified as melee and fighter

tsm_redis.lol.champions.getIntersection(['fighter', 'melee'], function (err, data) { console.log(data); });