js-libp2p/classes/_peer_routing_.peerrouting.html
2021-01-29 14:40:00 +01:00

507 lines
25 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PeerRouting | libp2p - v0.30.6</title>
<meta name="description" content="Documentation for libp2p - v0.30.6">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
<style>
.toolbar-icon {
display: inline-block;
vertical-align: middle;
margin-left: 10px;
cursor: pointer;
}
.toolbar-icon-search {
box-sizing: border-box;
position: absolute;
overflow: hidden;
right: -40px;
width: 40px;
height: 40px;
display: flex;
justify-content: center;
align-items: center;
@media (min-width: 901px){
display: none
}
}
@media (min-width: 901px){
.toolbar-icon-menu {
display: none
}
.toolbar-icon-options {
display: none
}
}
.gg-menu {
transform: scale(var(--ggs,1))
}
.gg-menu,
.gg-menu::after,
.gg-menu::before {
box-sizing: border-box;
position: relative;
display: block;
width: 20px;
height: 2px;
border-radius: 3px;
background: currentColor
}
.gg-menu::after,
.gg-menu::before {
content: "";
position: absolute;
top: -6px
}
.gg-menu::after {
top: 6px
}
.gg-options {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 10px;
height: 2px;
box-shadow:
-3px 4px 0 0,
3px -4px 0 0
}
.gg-options::after,
.gg-options::before {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
width: 8px;
height: 8px;
border: 2px solid;
border-radius: 100%
}
.gg-options::before {
top: -7px;
left: -4px
}
.gg-options::after {
bottom: -7px;
right: -4px
}
.gg-search {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 16px;
height: 16px;
border: 2px solid;
border-radius: 100%;
margin-left: -4px;
margin-top: -4px
}
.gg-search::after {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
border-radius: 3px;
width: 2px;
height: 8px;
background: currentColor;
transform: rotate(-45deg);
top: 10px;
left: 12px
}
</style>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></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">libp2p - v0.30.6</a>
</div>
<div class="table-cell" id="tsd-widgets">
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules/_peer_routing_.html">peer-routing</a>
</li>
<li>
<a href="_peer_routing_.peerrouting.html">PeerRouting</a>
</li>
</ul>
<h1>Class PeerRouting</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>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">PeerRouting</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>References</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#_peerid" class="tsd-kind-icon">_peer<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#_peerstore" class="tsd-kind-icon">_peer<wbr>Store</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#_refreshmanageroptions" class="tsd-kind-icon">_refresh<wbr>Manager<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#_routers" class="tsd-kind-icon">_routers</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#_timeoutid" class="tsd-kind-icon">_timeout<wbr>Id</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="_peer_routing_.peerrouting.html#_findclosestpeerstask" class="tsd-kind-icon">_find<wbr>Closest<wbr>Peers<wbr>Task</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#findpeer" class="tsd-kind-icon">find<wbr>Peer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#getclosestpeers" class="tsd-kind-icon">get<wbr>Closest<wbr>Peers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_peer_routing_.peerrouting.html#stop" class="tsd-kind-icon">stop</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>References</h2>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="multiaddr" class="tsd-anchor"></a>
<h3>Multiaddr</h3>
Re-exports <a href="../modules/_address_manager_index_.html#multiaddr">Multiaddr</a>
</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>Peer<wbr>Routing<span class="tsd-signature-symbol">(</span>libp2p<span class="tsd-signature-symbol">: </span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_peer_routing_.peerrouting.html" class="tsd-signature-type">PeerRouting</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>libp2p: <a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_peer_routing_.peerrouting.html" class="tsd-signature-type">PeerRouting</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_peerid" class="tsd-anchor"></a>
<h3>_peer<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">_peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_peerstore" class="tsd-anchor"></a>
<h3>_peer<wbr>Store</h3>
<div class="tsd-signature tsd-kind-icon">_peer<wbr>Store<span class="tsd-signature-symbol">:</span> <a href="../modules/_peer_store_book_.html#peerstore" class="tsd-signature-type">PeerStore</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_refreshmanageroptions" class="tsd-anchor"></a>
<h3>_refresh<wbr>Manager<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">_refresh<wbr>Manager<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_routers" class="tsd-anchor"></a>
<h3>_routers</h3>
<div class="tsd-signature tsd-kind-icon">_routers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_timeoutid" class="tsd-anchor"></a>
<h3>_timeout<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">_timeout<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</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="_findclosestpeerstask" class="tsd-anchor"></a>
<h3>_find<wbr>Closest<wbr>Peers<wbr>Task</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">_find<wbr>Closest<wbr>Peers<wbr>Task<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Recurrent task to find closest peers and add their addresses to the Address Book.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findpeer" class="tsd-anchor"></a>
<h3>find<wbr>Peer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<wbr>Peer<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Iterates over all peer routers in parallel to find the given peer.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
<div class="tsd-comment tsd-typography">
<p>The id of the peer to find</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
<blockquote>
<p>}</p>
</blockquote>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getclosestpeers" class="tsd-anchor"></a>
<h3>get<wbr>Closest<wbr>Peers</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Closest<wbr>Peers<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Attempt to find the closest peers on the network to the given key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">Uint8Array</span></h5>
<div class="tsd-comment tsd-typography">
<p>A CID like key</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
<blockquote>
<p>}</p>
</blockquote>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Start peer routing service.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Stop peer routing service.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="current tsd-kind-module">
<a href="../modules/_peer_routing_.html">peer-routing</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-module">
<a href="_peer_routing_.peerrouting.html" class="tsd-kind-icon">Peer<wbr>Routing</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_peerid" class="tsd-kind-icon">_peer<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_peerstore" class="tsd-kind-icon">_peer<wbr>Store</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_refreshmanageroptions" class="tsd-kind-icon">_refresh<wbr>Manager<wbr>Options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_routers" class="tsd-kind-icon">_routers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_timeoutid" class="tsd-kind-icon">_timeout<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#_findclosestpeerstask" class="tsd-kind-icon">_find<wbr>Closest<wbr>Peers<wbr>Task</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#findpeer" class="tsd-kind-icon">find<wbr>Peer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#getclosestpeers" class="tsd-kind-icon">get<wbr>Closest<wbr>Peers</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_peer_routing_.peerrouting.html#stop" class="tsd-kind-icon">stop</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_peer_routing_.html#multiaddr" class="tsd-kind-icon">Multiaddr</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-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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</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-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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>