lol-api-js
Version:
Integration package LoL Riot API and your typescript/javascript
36 lines • 20.4 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/index.html">index</a></li><li><a href="index.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><ul class="tsd-hierarchy"><li><a href="summoner.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul></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="index.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="index.default.html#dataPath" class="tsd-kind-icon">data<wbr/>Path</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="index.default.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="index.default.html#region" class="tsd-kind-icon">region</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#buildUrl" class="tsd-kind-icon">build<wbr/>Url</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getChampionMastery" class="tsd-kind-icon">get<wbr/>Champion<wbr/>Mastery</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getLeagues" class="tsd-kind-icon">get<wbr/>Leagues</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getMatchIds" class="tsd-kind-icon">get<wbr/>Match<wbr/>Ids</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getSummoner" class="tsd-kind-icon">get<wbr/>Summoner</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>api_key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.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/index.ts#L11">index.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>api_key: <span class="tsd-signature-type">string</span></h5></li><li><h5>path: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="index.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="dataPath" class="tsd-anchor"></a><h3>data<wbr/>Path</h3><div class="tsd-signature tsd-kind-icon">data<wbr/>Path<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/index.ts#L8">index.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="key" class="tsd-anchor"></a><h3>key</h3><div class="tsd-signature tsd-kind-icon">key<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/index.ts#L7">index.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="region" class="tsd-anchor"></a><h3>region</h3><div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "br1"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ricardobohadana/LoLjs/blob/d8ad743/src/index.ts#L9">index.ts:9</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="buildUrl" class="tsd-anchor"></a><h3>build<wbr/>Url</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">build<wbr/>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, identifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></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/index.ts#L35">index.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the URL with indentifiers, keys and search params`</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This method is part of lol-api-js package as a utils function</p>
</dd><dt>example</dt><dd><p>const rawURL = "<a href="https://www.google.com/"">https://www.google.com/"</a>;
const identifier = "search";
const args = {q: "I love artifical intelligence"};
const url = buildUrl(rawURL, identifier, args)
// url = "<a href="https://www.google.com/search?q=I+love+artificial+intelligence"">https://www.google.com/search?q=I+love+artificial+intelligence"</a></p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>string with the href</p>
</div></div></li><li><h5>identifier: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>string to join after the url with @var encodeURI</p>
</div></div></li><li><h5>args: <span class="tsd-signature-type">Object</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JSON Object with search parameters</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>A @var string that represents a URL with keys and params</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getChampionMastery" class="tsd-anchor"></a><h3>get<wbr/>Champion<wbr/>Mastery</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Champion<wbr/>Mastery<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/championMastery.championMasteryData.html" class="tsd-signature-type" data-tsd-kind="Interface">championMasteryData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></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/index.ts#L90">index.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sets the class properties @var championMastery as an <code>Array<ChampionMastery></code></p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This method is part of lol-api-js package and Summoner class</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/championMastery.championMasteryData.html" class="tsd-signature-type" data-tsd-kind="Interface">championMasteryData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getLeagues" class="tsd-anchor"></a><h3>get<wbr/>Leagues</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Leagues<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><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></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/index.ts#L113">index.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sets the summoner class properties @var rankedFlex and @var rankedSolo</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This method is part of lol-api-js package and API class</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getMatchIds" class="tsd-anchor"></a><h3>get<wbr/>Match<wbr/>Ids</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Match<wbr/>Ids<span class="tsd-signature-symbol">(</span>puuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></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/index.ts#L142">index.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns an Array of matchIds.</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This method is part of lol-api-js package and API class</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>puuid: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>optional pre-defined Object: <code>params = {start: 0, count: 20};</code></p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>An array of strings: <code>Array<string>;</code></p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getSummoner" class="tsd-anchor"></a><h3>get<wbr/>Summoner</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Summoner<span class="tsd-signature-symbol">(</span>summonerName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="summoner.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">></span></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/index.ts#L62">index.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Method to retrieve a summoner object from RiotGames API</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This method is part of lol-api-js package as a API class method</p>
</dd><dt>example</dt><dd><p>const api = new API('your Riot Api Key', 'your local datadragon path');
const summoner = api.getSummoner('summonerName');</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>summonerName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>a string containing the summoner name</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="summoner.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">></span></h4><div><p>A @var string that represents a URL with keys and params</p>
</div></li></ul></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="current tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" 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="index.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="index.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="index.default.html#dataPath" class="tsd-kind-icon">data<wbr/>Path</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="index.default.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="index.default.html#region" class="tsd-kind-icon">region</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#buildUrl" class="tsd-kind-icon">build<wbr/>Url</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getChampionMastery" class="tsd-kind-icon">get<wbr/>Champion<wbr/>Mastery</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getLeagues" class="tsd-kind-icon">get<wbr/>Leagues</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getMatchIds" class="tsd-kind-icon">get<wbr/>Match<wbr/>Ids</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="index.default.html#getSummoner" class="tsd-kind-icon">get<wbr/>Summoner</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><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</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>