lol-api-js
Version:
Integration package LoL Riot API and your typescript/javascript
1 lines • 15.5 kB
HTML
<html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>default | lol-api-js</title><meta name="description" content="Documentation for lol-api-js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">lol-api-js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">lol-api-js</a></li><li><a href="../modules/league.html">league</a></li><li><a href="league.default.html">default</a></li></ul><h1>Class default</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="league.default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#freshBlood" class="tsd-kind-icon">fresh<wbr/>Blood</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#hotStreak" class="tsd-kind-icon">hot<wbr/>Streak</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#inactive" class="tsd-kind-icon">inactive</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#leagueId" class="tsd-kind-icon">league<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#leaguePoints" class="tsd-kind-icon">league<wbr/>Points</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#losses" class="tsd-kind-icon">losses</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#queueType" class="tsd-kind-icon">queue<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#rank" class="tsd-kind-icon">rank</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#summonerId" class="tsd-kind-icon">summoner<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#summonerName" class="tsd-kind-icon">summoner<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#tier" class="tsd-kind-icon">tier</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#veteran" class="tsd-kind-icon">veteran</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#wins" class="tsd-kind-icon">wins</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>jsonObj<span class="tsd-signature-symbol">: </span><a href="../modules/league.html#leagueData" class="tsd-signature-type" data-tsd-kind="Type alias">leagueData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="league.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L16">league.ts:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jsonObj: <a href="../modules/league.html#leagueData" class="tsd-signature-type" data-tsd-kind="Type alias">leagueData</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="league.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="freshBlood" class="tsd-anchor"></a><h3>fresh<wbr/>Blood</h3><div class="tsd-signature tsd-kind-icon">fresh<wbr/>Blood<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L13">league.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="hotStreak" class="tsd-anchor"></a><h3>hot<wbr/>Streak</h3><div class="tsd-signature tsd-kind-icon">hot<wbr/>Streak<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L11">league.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="inactive" class="tsd-anchor"></a><h3>inactive</h3><div class="tsd-signature tsd-kind-icon">inactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L14">league.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="leagueId" class="tsd-anchor"></a><h3>league<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">league<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L2">league.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="leaguePoints" class="tsd-anchor"></a><h3>league<wbr/>Points</h3><div class="tsd-signature tsd-kind-icon">league<wbr/>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L8">league.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="losses" class="tsd-anchor"></a><h3>losses</h3><div class="tsd-signature tsd-kind-icon">losses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L10">league.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="queueType" class="tsd-anchor"></a><h3>queue<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">queue<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L5">league.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="rank" class="tsd-anchor"></a><h3>rank</h3><div class="tsd-signature tsd-kind-icon">rank<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L7">league.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="summonerId" class="tsd-anchor"></a><h3>summoner<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">summoner<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L3">league.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="summonerName" class="tsd-anchor"></a><h3>summoner<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">summoner<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L4">league.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="tier" class="tsd-anchor"></a><h3>tier</h3><div class="tsd-signature tsd-kind-icon">tier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L6">league.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="veteran" class="tsd-anchor"></a><h3>veteran</h3><div class="tsd-signature tsd-kind-icon">veteran<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L12">league.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="wins" class="tsd-anchor"></a><h3>wins</h3><div class="tsd-signature tsd-kind-icon">wins<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/league.ts#L9">league.ts:9</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/championMastery.html">champion<wbr/>Mastery</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class="current tsd-kind-module"><a href="../modules/league.html">league</a></li><li class=" tsd-kind-module"><a href="../modules/summoner.html">summoner</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="league.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="league.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#freshBlood" class="tsd-kind-icon">fresh<wbr/>Blood</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#hotStreak" class="tsd-kind-icon">hot<wbr/>Streak</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#inactive" class="tsd-kind-icon">inactive</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#leagueId" class="tsd-kind-icon">league<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#leaguePoints" class="tsd-kind-icon">league<wbr/>Points</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#losses" class="tsd-kind-icon">losses</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#queueType" class="tsd-kind-icon">queue<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#rank" class="tsd-kind-icon">rank</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#summonerId" class="tsd-kind-icon">summoner<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#summonerName" class="tsd-kind-icon">summoner<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#tier" class="tsd-kind-icon">tier</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#veteran" class="tsd-kind-icon">veteran</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="league.default.html#wins" class="tsd-kind-icon">wins</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>