@ellcrys/spell
Version:
The official JavaScript library for Ellcrys
611 lines • 28.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HDKey | Spell Documentation</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">Spell Documentation</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>
<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/key.html">Key</a>
</li>
<li>
<a href="key.hdkey.html">HDKey</a>
</li>
</ul>
<h1>Class HDKey</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>HDKey provides the ability to create
hierarchical deterministic keys.</p>
</div>
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>class</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">HDKey</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="key.hdkey.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="key.hdkey.html#mchaincode" class="tsd-kind-icon">m<wbr>Chain<wbr>Code</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="key.hdkey.html#mkey" class="tsd-kind-icon">m<wbr>Key</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="key.hdkey.html#chaincode" class="tsd-kind-icon">chain<wbr>Code</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="key.hdkey.html#ckd" class="tsd-kind-icon">ckd</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="key.hdkey.html#derive" class="tsd-kind-icon">derive</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="key.hdkey.html#key" class="tsd-kind-icon">key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="key.hdkey.html#privatekey" class="tsd-kind-icon">private<wbr>Key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="key.hdkey.html#frommasterseed" class="tsd-kind-icon">from<wbr>Master<wbr>Seed</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 HDKey<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, chainCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L434">key.ts:434</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an instance of HDKey.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Left half of the hmac digest</p>
</div>
</div>
</li>
<li>
<h5>chainCode: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Right half of the hmac digest</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="mchaincode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> m<wbr>Chain<wbr>Code</h3>
<div class="tsd-signature tsd-kind-icon">m<wbr>Chain<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L434">key.ts:434</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="mkey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> m<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">m<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L433">key.ts:433</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="chaincode" class="tsd-anchor"></a>
<h3>chain<wbr>Code</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">chain<wbr>Code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L463">key.ts:463</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the derived chain code</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="ckd" class="tsd-anchor"></a>
<h3>ckd</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">ckd<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, chainCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L476">key.ts:476</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Child key derivation function</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>The parent key</p>
</div>
</li>
<li>
<h5>chainCode: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>The parent chain code</p>
</div>
</li>
<li>
<h5>index: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The key index</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="derive" class="tsd-anchor"></a>
<h3>derive</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">derive<span class="tsd-signature-symbol">(</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="key.hdkey.html" class="tsd-signature-type">HDKey</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L496">key.ts:496</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a path, derive a child key. Path
must contain only hardened indices</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The derivation path</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="key" class="tsd-anchor"></a>
<h3>key</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L453">key.ts:453</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the derived key</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="privatekey" class="tsd-anchor"></a>
<h3>private<wbr>Key</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">private<wbr>Key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L523">key.ts:523</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the private key created using the
derived key</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="frommasterseed" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Master<wbr>Seed</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Master<wbr>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/key.ts#L425">key.ts:425</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create an HDKey from a seed.</p>
</div>
<dl class="tsd-comment-tags">
<dt>static</dt>
<dd></dd>
<dt>memberof</dt>
<dd><p>HDKey</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>seed: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="key.hdkey.html" class="tsd-signature-type">HDKey</a></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=" tsd-kind-external-module">
<a href="../modules/auth.html">Auth</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/ell.html">Ell</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/errors.html">Errors</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/index.html">Index</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/key.html">Key</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/logger.html">Logger</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/miner.html">Miner</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/namespace.html">Namespace</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/net.html">Net</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/node.html">Node</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/pool.html">Pool</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/rpc.html">RPC</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/rpcclient.html">RPCClient</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/spell.html">Spell</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/state.html">State</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/transactionbuilder.html">Transaction<wbr>Builder</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/txutility.html">Tx<wbr>Utility</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="key.address.html" class="tsd-kind-icon">Address</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="key.hdkey.html" class="tsd-kind-icon">HDKey</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="key.hdkey.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="key.hdkey.html#mchaincode" class="tsd-kind-icon">m<wbr>Chain<wbr>Code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="key.hdkey.html#mkey" class="tsd-kind-icon">m<wbr>Key</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="key.hdkey.html#chaincode" class="tsd-kind-icon">chain<wbr>Code</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="key.hdkey.html#ckd" class="tsd-kind-icon">ckd</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="key.hdkey.html#derive" class="tsd-kind-icon">derive</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="key.hdkey.html#key" class="tsd-kind-icon">key</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="key.hdkey.html#privatekey" class="tsd-kind-icon">private<wbr>Key</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="key.hdkey.html#frommasterseed" class="tsd-kind-icon">from<wbr>Master<wbr>Seed</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="key.privatekey.html" class="tsd-kind-icon">Private<wbr>Key</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="key.publickey.html" class="tsd-kind-icon">Public<wbr>Key</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/key.html#addressversion" class="tsd-kind-icon">Address<wbr>Version</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#ed25519_curve" class="tsd-kind-icon">ED25519_<wbr>CURVE</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#hardened_offset" class="tsd-kind-icon">HARDENED_<wbr>OFFSET</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/key.html#privatekeyversion" class="tsd-kind-icon">Private<wbr>Key<wbr>Version</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/key.html#publickeyversion" class="tsd-kind-icon">Public<wbr>Key<wbr>Version</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#ripemd160" class="tsd-kind-icon">RIPEMD160</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#sha3" class="tsd-kind-icon">SHA3</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#b58" class="tsd-kind-icon">b58</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#pathregex" class="tsd-kind-icon">path<wbr>Regex</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/key.html#isvalidpath" class="tsd-kind-icon">is<wbr>Valid<wbr>Path</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/key.html#replacederive" class="tsd-kind-icon">replace<wbr>Derive</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<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="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>