@bitclave/base-client-js
Version:
Base JS library for BASE-platform
492 lines • 29.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountManager | @bitclave/base-client-js</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.js" 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">@bitclave/base-client-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-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_manager_accountmanager_.html">"manager/AccountManager"</a>
</li>
<li>
<a href="_manager_accountmanager_.accountmanager.html">AccountManager</a>
</li>
</ul>
<h1>Interface AccountManager</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">AccountManager</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_manager_accountmanagerimpl_.accountmanagerimpl.html" class="tsd-signature-type">AccountManagerImpl</a></li>
<li><a href="../classes/_manager_remote_remoteaccountmanagerimpl_.remoteaccountmanagerimpl.html" class="tsd-signature-type">RemoteAccountManagerImpl</a></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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#authenticationbyaccesstoken" class="tsd-kind-icon">authentication<wbr>ByAccess<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#authenticationbypassphrase" class="tsd-kind-icon">authentication<wbr>ByPass<wbr>Phrase</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#checkaccount" class="tsd-kind-icon">check<wbr>Account</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#getnewmnemonic" class="tsd-kind-icon">get<wbr>New<wbr>Mnemonic</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#getpublickeyfrommnemonic" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#registration" class="tsd-kind-icon">registration</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_manager_accountmanager_.accountmanager.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="authenticationbyaccesstoken" class="tsd-anchor"></a>
<h3>authentication<wbr>ByAccess<wbr>Token</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">authentication<wbr>ByAccess<wbr>Token<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenType<span class="tsd-signature-symbol">: </span><a href="../enums/_utils_keypair_rpc_rpctoken_.tokentype.html" class="tsd-signature-type">TokenType</a>, message<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="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L33">manager/AccountManager.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if user with provided access token is already registered in the system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>token for authenticate on remote signer
(if <a href="_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a> support <a href="_utils_keypair_accesstokenaccepter_.accesstokenaccepter.html">AccessTokenAccepter</a>)</p>
</div>
</li>
<li>
<h5>tokenType: <a href="../enums/_utils_keypair_rpc_rpctoken_.tokentype.html" class="tsd-signature-type">TokenType</a></h5>
<div class="tsd-comment tsd-typography">
<p>type of token</p>
</div>
</li>
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>on the basis of which a signature will be created to verify the public key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
<p>{Account} if client exist or http exception if fail.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="authenticationbypassphrase" class="tsd-anchor"></a>
<h3>authentication<wbr>ByPass<wbr>Phrase</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">authentication<wbr>ByPass<wbr>Phrase<span class="tsd-signature-symbol">(</span>passPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<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="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L20">manager/AccountManager.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks or Register user with provided mnemonic phrase is already registered in the system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>passPhrase: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Mnemonic phrase for Public/Private key pair
generation for asymmetric encryption scheme.</p>
</div>
</li>
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>on the basis of which a signature will be created to verify the public key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
<p>{Account} if client exist or create new user.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="checkaccount" class="tsd-anchor"></a>
<h3>check<wbr>Account</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">check<wbr>Account<span class="tsd-signature-symbol">(</span>mnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<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="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L53">manager/AccountManager.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if user with provided mnemonic phrase is already registered in the system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mnemonicPhrase: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Mnemonic phrase for Public/Private key pair
generation for asymmetric encryption scheme.</p>
</div>
</li>
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>on the basis of which a signature will be created to verify the public key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
<p>{Account} if client exist or http exception if fail.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getaccount" class="tsd-anchor"></a>
<h3>get<wbr>Account</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L64">manager/AccountManager.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getnewmnemonic" class="tsd-anchor"></a>
<h3>get<wbr>New<wbr>Mnemonic</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>New<wbr>Mnemonic<span class="tsd-signature-symbol">(</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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L62">manager/AccountManager.ts:62</a></li>
</ul>
</aside>
<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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getpublickeyfrommnemonic" class="tsd-anchor"></a>
<h3>get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonicPhrase<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><span class="tsd-signature-type">string</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L66">manager/AccountManager.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mnemonicPhrase: <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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="registration" class="tsd-anchor"></a>
<h3>registration</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">registration<span class="tsd-signature-symbol">(</span>mnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<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="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L43">manager/AccountManager.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers a new user in the system.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mnemonicPhrase: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Mnemonic phrase for Public/Private key pair
generation for asymmetric encryption scheme.</p>
</div>
</li>
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>on the basis of which a signature will be created to verify the public key</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
<p>{Account} after successful registration or http exception if fail.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="subscribeaccount" class="tsd-anchor"></a>
<h3>subscribe<wbr>Account</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Account<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L10">manager/AccountManager.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><a href="../classes/_repository_models_account_.account.html" class="tsd-signature-type">Account</a><span class="tsd-signature-symbol">></span></h4>
<p>subscription to {Account}</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="unsubscribe" class="tsd-anchor"></a>
<h3>unsubscribe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">(</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">void</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/bitclave/base-client-js/blob/6a3b2763/src/manager/AccountManager.ts#L60">manager/AccountManager.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allows user to unsubscribe from BASE. Delets all his data</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
<p>void if client exist or http exception if fail.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_manager_accountmanager_.html">"manager/<wbr>Account<wbr>Manager"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_manager_accountmanager_.accountmanager.html" class="tsd-kind-icon">Account<wbr>Manager</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#authenticationbyaccesstoken" class="tsd-kind-icon">authentication<wbr>ByAccess<wbr>Token</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#authenticationbypassphrase" class="tsd-kind-icon">authentication<wbr>ByPass<wbr>Phrase</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#checkaccount" class="tsd-kind-icon">check<wbr>Account</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#getaccount" class="tsd-kind-icon">get<wbr>Account</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#getnewmnemonic" class="tsd-kind-icon">get<wbr>New<wbr>Mnemonic</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#getpublickeyfrommnemonic" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#registration" class="tsd-kind-icon">registration</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#subscribeaccount" class="tsd-kind-icon">subscribe<wbr>Account</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_manager_accountmanager_.accountmanager.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>