league-wrapper/lib/dto/match/team.js

REST API Wrapper for the League of Legends API

'use strict';

const convert = require('../../util/convert.js');

const BannedChampion = require('./banned-champion.js');

/**
 * @class
 * @alias module:LeagueWrapper/dto/match~Team
 * @property {Array.<module:LeagueWrapper/dto/match~BannedChampion>} bans - If game was draft mode, contains banned champion data, otherwise null
 * @property {number} baronKills - Number of times the team killed baron
 * @property {number} dominionVictoryScore - If game was a dominion game, specifies the points the team had at game end, otherwise null
 * @property {number} dragonKills - Number of times the team killed dragon
 * @property {boolean} firstBaron - Flag indicating whether or not the team got the first baron kill
 * @property {boolean} firstBlood - Flag indicating whether or not the team got first blood
 * @property {boolean} firstDragon - Flag indicating whether or not the team got the first dragon kill
 * @property {boolean} firstInhibitor - Flag indicating whether or not the team destroyed the first inhibitor
 * @property {boolean} firstRiftHerald - Flag indicating whether or not the team got the first rift herald kill
 * @property {boolean} firstTower - Flag indicating whether or not the team destroyed the first tower
 * @property {number} inhibitorKills - Number of inhibitors the team destroyed
 * @property {number} riftHeraldKills - Number of times the team killed rift herald
 * @property {number} teamId - Team ID
 * @property {number} towerKills - Number of towers the team destroyed
 * @property {number} vilemawKills - Number of times the team killed vilemaw
 * @property {boolean} winner - Flag indicating whether or not the team won
 */
class Team {
  constructor(data) {
    this.bans = convert(data.bans, [BannedChampion]);
    this.baronKills = convert(data.baronKills, Number);
    this.dominionVictoryScore = convert(data.dominionVictoryScore, Number);
    this.dragonKills = convert(data.dragonKills, Number);
    this.firstBaron = convert(data.firstBaron, Boolean);
    this.firstBlood = convert(data.firstBlood, Boolean);
    this.firstDragon = convert(data.firstDragon, Boolean);
    this.firstInhibitor = convert(data.firstInhibitor, Boolean);
    this.firstRiftHerald = convert(data.firstRiftHerald, Boolean);
    this.firstTower = convert(data.firstTower, Boolean);
    this.inhibitorKills = convert(data.inhibitorKills, Number);
    this.riftHeraldKills = convert(data.riftHeraldKills, Number);
    this.teamId = convert(data.teamId, Number);
    this.towerKills = convert(data.towerKills, Number);
    this.vilemawKills = convert(data.vilemawKills, Number);
    this.winner = convert(data.winner, Boolean);
  }
}

exports = module.exports = Team;