@bitclave/base-client-js
Version:
Base JS library for BASE-platform
703 lines • 50.6 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BitKeyPair | @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/_utils_keypair_bitkeypair_.html">"utils/keypair/BitKeyPair"</a>
</li>
<li>
<a href="_utils_keypair_bitkeypair_.bitkeypair.html">BitKeyPair</a>
</li>
</ul>
<h1>Class BitKeyPair</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">BitKeyPair</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html" class="tsd-signature-type">KeyPairHelper</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#constructor" class="tsd-kind-icon">constructor</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="_utils_keypair_bitkeypair_.bitkeypair.html#checksig" class="tsd-kind-icon">check<wbr>Sig</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#createkeypair" class="tsd-kind-icon">create<wbr>Key<wbr>Pair</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptfields" class="tsd-kind-icon">decrypt<wbr>Fields</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptfile" class="tsd-kind-icon">decrypt<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptmessage" class="tsd-kind-icon">decrypt<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfields" class="tsd-kind-icon">encrypt<wbr>Fields</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfieldswithpermissions" class="tsd-kind-icon">encrypt<wbr>Fields<wbr>With<wbr>Permissions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfile" class="tsd-kind-icon">encrypt<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptmessage" class="tsd-kind-icon">encrypt<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptpermissionsfields" class="tsd-kind-icon">encrypt<wbr>Permissions<wbr>Fields</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#generatemnemonicphrase" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#getaddr" class="tsd-kind-icon">get<wbr>Addr</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#getpublickey" class="tsd-kind-icon">get<wbr>Public<wbr>Key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#generatemnemonicphrase-1" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_keypair_bitkeypair_.bitkeypair.html#getpublickeyfrommnemonic" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</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 <wbr>Bit<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>permissionsSource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_repository_assistant_permissionssource_.permissionssource.html" class="tsd-signature-type">PermissionsSource</a>, siteDataSource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_repository_assistant_sitedatasource_.sitedatasource.html" class="tsd-signature-type">SiteDataSource</a>, origin<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="_utils_keypair_bitkeypair_.bitkeypair.html" class="tsd-signature-type">BitKeyPair</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/utils/keypair/BitKeyPair.ts#L57">utils/keypair/BitKeyPair.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>permissionsSource: <a href="../interfaces/_repository_assistant_permissionssource_.permissionssource.html" class="tsd-signature-type">PermissionsSource</a></h5>
</li>
<li>
<h5>siteDataSource: <a href="../interfaces/_repository_assistant_sitedatasource_.sitedatasource.html" class="tsd-signature-type">SiteDataSource</a></h5>
</li>
<li>
<h5>origin: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_utils_keypair_bitkeypair_.bitkeypair.html" class="tsd-signature-type">BitKeyPair</a></h4>
</li>
</ul>
</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="checksig" class="tsd-anchor"></a>
<h3>check<wbr>Sig</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">check<wbr>Sig<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sig<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">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#checksig">checkSig</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L94">utils/keypair/BitKeyPair.ts:94</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>sig: <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">boolean</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="createkeypair" class="tsd-anchor"></a>
<h3>create<wbr>Key<wbr>Pair</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>passPhrase<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="_utils_keypair_keypair_.keypair.html" class="tsd-signature-type">KeyPair</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#createkeypair">createKeyPair</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L66">utils/keypair/BitKeyPair.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>passPhrase: <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="_utils_keypair_keypair_.keypair.html" class="tsd-signature-type">KeyPair</a><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="decryptfields" class="tsd-anchor"></a>
<h3>decrypt<wbr>Fields</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Fields<span class="tsd-signature-symbol">(</span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span>, passwords<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#decryptfields">decryptFields</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L198">utils/keypair/BitKeyPair.ts:198</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fields: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> passwords: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="decryptfile" class="tsd-anchor"></a>
<h3>decrypt<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>File<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#decryptfile">decryptFile</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L180">utils/keypair/BitKeyPair.ts:180</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>file: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>filedName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> password: <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-class">
<a name="decryptmessage" class="tsd-anchor"></a>
<h3>decrypt<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Message<span class="tsd-signature-symbol">(</span>senderPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encrypted<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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#decryptmessage">decryptMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L188">utils/keypair/BitKeyPair.ts:188</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>senderPk: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>encrypted: <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-class">
<a name="encryptfields" class="tsd-anchor"></a>
<h3>encrypt<wbr>Fields</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Fields<span class="tsd-signature-symbol">(</span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#encryptfields">encryptFields</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L123">utils/keypair/BitKeyPair.ts:123</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fields: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="encryptfieldswithpermissions" class="tsd-anchor"></a>
<h3>encrypt<wbr>Fields<wbr>With<wbr>Permissions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Fields<wbr>With<wbr>Permissions<span class="tsd-signature-symbol">(</span>recipient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../enums/_utils_keypair_permissions_.accessright.html" class="tsd-signature-type">AccessRight</a><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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#encryptfieldswithpermissions">encryptFieldsWithPermissions</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L149">utils/keypair/BitKeyPair.ts:149</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>recipient: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../enums/_utils_keypair_permissions_.accessright.html" class="tsd-signature-type">AccessRight</a><span class="tsd-signature-symbol">></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">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="encryptfile" class="tsd-anchor"></a>
<h3>encrypt<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>File<span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filedName<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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#encryptfile">encryptFile</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L173">utils/keypair/BitKeyPair.ts:173</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>file: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>filedName: <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-class">
<a name="encryptmessage" class="tsd-anchor"></a>
<h3>encrypt<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Message<span class="tsd-signature-symbol">(</span>recipientPk<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><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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#encryptmessage">encryptMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L115">utils/keypair/BitKeyPair.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>recipientPk: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>message: <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-class">
<a name="encryptpermissionsfields" class="tsd-anchor"></a>
<h3>encrypt<wbr>Permissions<wbr>Fields</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Permissions<wbr>Fields<span class="tsd-signature-symbol">(</span>recipient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../enums/_utils_keypair_permissions_.accessright.html" class="tsd-signature-type">AccessRight</a><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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#encryptpermissionsfields">encryptPermissionsFields</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L127">utils/keypair/BitKeyPair.ts:127</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>recipient: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../enums/_utils_keypair_permissions_.accessright.html" class="tsd-signature-type">AccessRight</a><span class="tsd-signature-symbol">></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-class">
<a name="generatemnemonicphrase" class="tsd-anchor"></a>
<h3>generate<wbr>Mnemonic<wbr>Phrase</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase<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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#generatemnemonicphrase">generateMnemonicPhrase</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L80">utils/keypair/BitKeyPair.ts:80</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-class">
<a name="getaddr" class="tsd-anchor"></a>
<h3>get<wbr>Addr</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Addr<span class="tsd-signature-symbol">(</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/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L111">utils/keypair/BitKeyPair.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpublickey" class="tsd-anchor"></a>
<h3>get<wbr>Public<wbr>Key</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#getpublickey">getPublicKey</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L107">utils/keypair/BitKeyPair.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="signmessage" class="tsd-anchor"></a>
<h3>sign<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Message<span class="tsd-signature-symbol">(</span>data<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">
<p>Implementation of <a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html">KeyPairHelper</a>.<a href="../interfaces/_utils_keypair_keypairhelper_.keypairhelper.html#signmessage">signMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L88">utils/keypair/BitKeyPair.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <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-class tsd-is-static">
<a name="generatemnemonicphrase-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> generate<wbr>Mnemonic<wbr>Phrase</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase<span class="tsd-signature-symbol">(</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/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L55">utils/keypair/BitKeyPair.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="getpublickeyfrommnemonic" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>passPhrase<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">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/bitclave/base-client-js/blob/6a3b2763/src/utils/keypair/BitKeyPair.ts#L45">utils/keypair/BitKeyPair.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>passPhrase: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</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/_utils_keypair_bitkeypair_.html">"utils/keypair/<wbr>Bit<wbr>Key<wbr>Pair"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html" class="tsd-kind-icon">Bit<wbr>Key<wbr>Pair</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#checksig" class="tsd-kind-icon">check<wbr>Sig</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#createkeypair" class="tsd-kind-icon">create<wbr>Key<wbr>Pair</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptfields" class="tsd-kind-icon">decrypt<wbr>Fields</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptfile" class="tsd-kind-icon">decrypt<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#decryptmessage" class="tsd-kind-icon">decrypt<wbr>Message</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfields" class="tsd-kind-icon">encrypt<wbr>Fields</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfieldswithpermissions" class="tsd-kind-icon">encrypt<wbr>Fields<wbr>With<wbr>Permissions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptfile" class="tsd-kind-icon">encrypt<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptmessage" class="tsd-kind-icon">encrypt<wbr>Message</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#encryptpermissionsfields" class="tsd-kind-icon">encrypt<wbr>Permissions<wbr>Fields</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#generatemnemonicphrase" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#getaddr" class="tsd-kind-icon">get<wbr>Addr</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#getpublickey" class="tsd-kind-icon">get<wbr>Public<wbr>Key</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#generatemnemonicphrase-1" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Phrase</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_utils_keypair_bitkeypair_.bitkeypair.html#getpublickeyfrommnemonic" class="tsd-kind-icon">get<wbr>Public<wbr>Key<wbr>From<wbr>Mnemonic</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_utils_keypair_bitkeypair_.address.html" class="tsd-kind-icon">Address</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_utils_keypair_bitkeypair_.privatekey.html" class="tsd-kind-icon">Private<wbr>Key</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/_utils_keypair_bitkeypair_.publickey.html" class="tsd-kind-icon">Public<wbr>Key</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_utils_keypair_bitkeypair_.html#ecies" class="tsd-kind-icon">ECIES</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_utils_keypair_bitkeypair_.html#message" class="tsd-kind-icon">Message</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_utils_keypair_bitkeypair_.html#mnemonic" class="tsd-kind-icon">Mnemonic</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_utils_keypair_bitkeypair_.html#bitcore" class="tsd-kind-icon">bitcore</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-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>