<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>node-albion-api</title>
<meta name="description" content="Documentation for node-albion-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/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-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">node-albion-api</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">
<h1>node-albion-api</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#albion-killboard-api-client" id="albion-killboard-api-client" style="color: inherit; text-decoration: none;">
<h1>Albion killboard api client</h1>
</a>
<p>Node JS Typescript client to interact with albion killboard API.</p>
<p>Doesn't work for frontend js due to cross origin policies.</p>
<a href="#disclaimer" id="disclaimer" style="color: inherit; text-decoration: none;">
<h2>Disclaimer</h2>
</a>
<p>Not all available API endpoints are covered. Only the one I needed yet.
Feel free to PR or create and issue for the missing features.</p>
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
<h2>Install</h2>
</a>
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">i</span><span style="color: #000000"> </span><span style="color: #001080">node</span><span style="color: #000000">-</span><span style="color: #001080">albion</span><span style="color: #000000">-</span><span style="color: #001080">api</span>
</code></pre>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<p>All the methods are async and return promises.</p>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">AlbionKillboard</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'node-albion-api'</span><span style="color: #000000">;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">api</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">AlbionKillboard</span><span style="color: #000000">();</span>
</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/albionkillboard.html" class="tsd-kind-icon">Albion<wbr>Killboard</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/equipement.html" class="tsd-kind-icon">Equipement</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/item.html" class="tsd-kind-icon">Item</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/killevent.html" class="tsd-kind-icon">Kill<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/tooninkillevent.html" class="tsd-kind-icon">Toon<wbr>InKill<wbr>Event</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#killarea" class="tsd-kind-icon">Kill<wbr>Area</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#killtype" class="tsd-kind-icon">Kill<wbr>Type</a>
</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</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/js/main.js"></script>
</body>
</html>