chore: update documentation

This commit is contained in:
Vasco Santos
2021-04-15 09:52:47 +02:00
parent fd3f801ba8
commit a1bda62962
131 changed files with 8969 additions and 45630 deletions

View File

@ -1,732 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EventEmitter | libp2p - v0.30.12</title>
<meta name="description" content="Documentation for libp2p - v0.30.12">
<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.12</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/_types_.html">types</a>
</li>
<li>
<a href="_types_.eventemitter.html">EventEmitter</a>
</li>
</ul>
<h1>Interface EventEmitter</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">EventEmitter</span>
<ul class="tsd-hierarchy">
<li>
<a href="../classes/_address_manager_index_.addressmanager.html" class="tsd-signature-type">AddressManager</a>
</li>
<li>
<a href="../classes/_peer_store_index_.peerstore.html" class="tsd-signature-type">PeerStore</a>
</li>
<li>
<a href="../classes/_connection_manager_latency_monitor_.latencymonitor.html" class="tsd-signature-type">LatencyMonitor</a>
</li>
<li>
<a href="../classes/_connection_manager_index_.connectionmanager.html" class="tsd-signature-type">ConnectionManager</a>
</li>
<li>
<a href="../classes/_metrics_stats_.stats.html" class="tsd-signature-type">Stats</a>
</li>
<li>
<a href="../classes/__libp2p_.libp2p.html" class="tsd-signature-type">Libp2p</a>
</li>
<li>
<a href="../classes/_connection_manager_visibility_change_emitter_.visibilitychangeemitter.html" class="tsd-signature-type">VisibilityChangeEmitter</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#emit" class="tsd-kind-icon">emit</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#listeners" class="tsd-kind-icon">listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#off" class="tsd-kind-icon">off</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#on" class="tsd-kind-icon">on</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#once" class="tsd-kind-icon">once</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_types_.eventemitter.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="addlistener" class="tsd-anchor"></a>
<h3>add<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">add<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="emit" class="tsd-anchor"></a>
<h3>emit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getmaxlisteners" class="tsd-anchor"></a>
<h3>get<wbr>Max<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="listenercount" class="tsd-anchor"></a>
<h3>listener<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">listener<wbr>Count<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="listeners" class="tsd-anchor"></a>
<h3>listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="off" class="tsd-anchor"></a>
<h3>off</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="on" class="tsd-anchor"></a>
<h3>on</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="once" class="tsd-anchor"></a>
<h3>once</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="rawlisteners" class="tsd-anchor"></a>
<h3>raw<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">raw<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="removealllisteners" class="tsd-anchor"></a>
<h3>remove<wbr>All<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="removelistener" class="tsd-anchor"></a>
<h3>remove<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="setmaxlisteners" class="tsd-anchor"></a>
<h3>set<wbr>Max<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span>n<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><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>n: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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/_types_.html">types</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/_types_.keytype.html" class="tsd-kind-icon">Key<wbr>Type</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_types_.eventemitter.html" class="tsd-kind-icon">Event<wbr>Emitter</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#emit" class="tsd-kind-icon">emit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#listeners" class="tsd-kind-icon">listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#off" class="tsd-kind-icon">off</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#on" class="tsd-kind-icon">on</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#once" class="tsd-kind-icon">once</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_types_.eventemitter.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_types_.eventemitterfactory.html" class="tsd-kind-icon">Event<wbr>Emitter<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#can_hop" class="tsd-kind-icon">CAN_<wbr>HOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitmessageproto" class="tsd-kind-icon">Circuit<wbr>Message<wbr>Proto</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitpeer" class="tsd-kind-icon">Circuit<wbr>Peer</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitrequest" class="tsd-kind-icon">Circuit<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitstatus" class="tsd-kind-icon">Circuit<wbr>Status</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuittype" class="tsd-kind-icon">Circuit<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop-1" class="tsd-kind-icon">HOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_dial_dst-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>DIAL_<wbr>DST</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_open_dst_stream-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>OPEN_<wbr>DST_<wbr>STREAM</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_relay_to_self-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>RELAY_<wbr>TO_<wbr>SELF</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_speak_relay-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>SPEAK_<wbr>RELAY</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_dst_addr_too_long-1" class="tsd-kind-icon">HOP_<wbr>DST_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_dst_multiaddr_invalid-1" class="tsd-kind-icon">HOP_<wbr>DST_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_no_conn_to_dst-1" class="tsd-kind-icon">HOP_<wbr>NO_<wbr>CONN_<wbr>TO_<wbr>DST</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_src_addr_too_long-1" class="tsd-kind-icon">HOP_<wbr>SRC_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_src_multiaddr_invalid-1" class="tsd-kind-icon">HOP_<wbr>SRC_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#malformed_message-1" class="tsd-kind-icon">MALFORMED_<wbr>MESSAGE</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#messageproto" class="tsd-kind-icon">Message<wbr>Proto</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#status-2" class="tsd-kind-icon">STATUS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop-1" class="tsd-kind-icon">STOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_dst_addr_too_long-1" class="tsd-kind-icon">STOP_<wbr>DST_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_dst_multiaddr_invalid-1" class="tsd-kind-icon">STOP_<wbr>DST_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_relay_refused-1" class="tsd-kind-icon">STOP_<wbr>RELAY_<wbr>REFUSED</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_src_addr_too_long-1" class="tsd-kind-icon">STOP_<wbr>SRC_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_src_multiaddr_invalid-1" class="tsd-kind-icon">STOP_<wbr>SRC_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#success-1" class="tsd-kind-icon">SUCCESS</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-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-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@ -1,337 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EventEmitterFactory | libp2p - v0.30.12</title>
<meta name="description" content="Documentation for libp2p - v0.30.12">
<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.12</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/_types_.html">types</a>
</li>
<li>
<a href="_types_.eventemitterfactory.html">EventEmitterFactory</a>
</li>
</ul>
<h1>Interface EventEmitterFactory</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">EventEmitterFactory</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-interface"><a href="_types_.eventemitterfactory.html#constructor" class="tsd-kind-icon">constructor</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-interface">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">new <wbr>Event<wbr>Emitter<wbr>Factory<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_.eventemitter.html" class="tsd-signature-type">EventEmitter</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <a href="_types_.eventemitter.html" class="tsd-signature-type">EventEmitter</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="current tsd-kind-module">
<a href="../modules/_types_.html">types</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/_types_.keytype.html" class="tsd-kind-icon">Key<wbr>Type</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_types_.eventemitter.html" class="tsd-kind-icon">Event<wbr>Emitter</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_types_.eventemitterfactory.html" class="tsd-kind-icon">Event<wbr>Emitter<wbr>Factory</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-interface">
<a href="_types_.eventemitterfactory.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#can_hop" class="tsd-kind-icon">CAN_<wbr>HOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitmessageproto" class="tsd-kind-icon">Circuit<wbr>Message<wbr>Proto</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitpeer" class="tsd-kind-icon">Circuit<wbr>Peer</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitrequest" class="tsd-kind-icon">Circuit<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuitstatus" class="tsd-kind-icon">Circuit<wbr>Status</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#circuittype" class="tsd-kind-icon">Circuit<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop-1" class="tsd-kind-icon">HOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_dial_dst-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>DIAL_<wbr>DST</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_open_dst_stream-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>OPEN_<wbr>DST_<wbr>STREAM</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_relay_to_self-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>RELAY_<wbr>TO_<wbr>SELF</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_cant_speak_relay-1" class="tsd-kind-icon">HOP_<wbr>CANT_<wbr>SPEAK_<wbr>RELAY</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_dst_addr_too_long-1" class="tsd-kind-icon">HOP_<wbr>DST_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_dst_multiaddr_invalid-1" class="tsd-kind-icon">HOP_<wbr>DST_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_no_conn_to_dst-1" class="tsd-kind-icon">HOP_<wbr>NO_<wbr>CONN_<wbr>TO_<wbr>DST</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_src_addr_too_long-1" class="tsd-kind-icon">HOP_<wbr>SRC_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#hop_src_multiaddr_invalid-1" class="tsd-kind-icon">HOP_<wbr>SRC_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#malformed_message-1" class="tsd-kind-icon">MALFORMED_<wbr>MESSAGE</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#messageproto" class="tsd-kind-icon">Message<wbr>Proto</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#status-2" class="tsd-kind-icon">STATUS</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop-1" class="tsd-kind-icon">STOP</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_dst_addr_too_long-1" class="tsd-kind-icon">STOP_<wbr>DST_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_dst_multiaddr_invalid-1" class="tsd-kind-icon">STOP_<wbr>DST_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_relay_refused-1" class="tsd-kind-icon">STOP_<wbr>RELAY_<wbr>REFUSED</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_src_addr_too_long-1" class="tsd-kind-icon">STOP_<wbr>SRC_<wbr>ADDR_<wbr>TOO_<wbr>LONG</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#stop_src_multiaddr_invalid-1" class="tsd-kind-icon">STOP_<wbr>SRC_<wbr>MULTIADDR_<wbr>INVALID</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/_types_.html#success-1" class="tsd-kind-icon">SUCCESS</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-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-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>constructorOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="constructoroptions.html">constructorOptions</a>
</li>
</ul>
<h1>Interface constructorOptions</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">constructorOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="constructoroptions.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
</ul>
</section>
</div>
</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-interface">
<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> <span class="tsd-signature-type">PeerId</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L122">src/index.js:122</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="constructoroptions.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CreateOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="createoptions.html">CreateOptions</a>
</li>
</ul>
<h1>Interface CreateOptions</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">CreateOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="createoptions.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
</ul>
</section>
</div>
</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-interface">
<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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PeerId</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L125">src/index.js:125</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="createoptions.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

257
interfaces/dhtoptions.html Normal file
View File

@ -0,0 +1,257 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DhtOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="dhtoptions.html">DhtOptions</a>
</li>
</ul>
<h1>Interface DhtOptions</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">DhtOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dhtoptions.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dhtoptions.html#kbucketsize" class="tsd-kind-icon">k<wbr>Bucket<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dhtoptions.html#randomwalk" class="tsd-kind-icon">random<wbr>Walk</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L66">src/index.js:66</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="kbucketsize" class="tsd-anchor"></a>
<h3>k<wbr>Bucket<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">k<wbr>Bucket<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L67">src/index.js:67</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="randomwalk" class="tsd-anchor"></a>
<h3>random<wbr>Walk</h3>
<div class="tsd-signature tsd-kind-icon">random<wbr>Walk<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="randomwalkoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomWalkOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L68">src/index.js:68</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="dhtoptions.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="dhtoptions.html#kbucketsize" class="tsd-kind-icon">k<wbr>Bucket<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="dhtoptions.html#randomwalk" class="tsd-kind-icon">random<wbr>Walk</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,257 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HandlerProps | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="handlerprops.html">HandlerProps</a>
</li>
</ul>
<h1>Interface HandlerProps</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">HandlerProps</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="handlerprops.html#connection" class="tsd-kind-icon">connection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="handlerprops.html#protocol" class="tsd-kind-icon">protocol</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="handlerprops.html#stream" class="tsd-kind-icon">stream</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="connection" class="tsd-anchor"></a>
<h3>connection</h3>
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connection</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L55">src/index.js:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="protocol" class="tsd-anchor"></a>
<h3>protocol</h3>
<div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L57">src/index.js:57</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stream" class="tsd-anchor"></a>
<h3>stream</h3>
<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MuxedStream</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L56">src/index.js:56</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="handlerprops.html#connection" class="tsd-kind-icon">connection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="handlerprops.html#protocol" class="tsd-kind-icon">protocol</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="handlerprops.html#stream" class="tsd-kind-icon">stream</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>KeychainOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="keychainoptions.html">KeychainOptions</a>
</li>
</ul>
<h1>Interface KeychainOptions</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">KeychainOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychainoptions.html#datastore" class="tsd-kind-icon">datastore</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="datastore" class="tsd-anchor"></a>
<h3>datastore</h3>
<div class="tsd-signature tsd-kind-icon">datastore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Datastore</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L71">src/index.js:71</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychainoptions.html#datastore" class="tsd-kind-icon">datastore</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,314 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pConfig | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="libp2pconfig.html">Libp2pConfig</a>
</li>
</ul>
<h1>Interface Libp2pConfig</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">Libp2pConfig</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#dht" class="tsd-kind-icon">dht</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#nat" class="tsd-kind-icon">nat</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#peerdiscovery" class="tsd-kind-icon">peer<wbr>Discovery</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#pubsub" class="tsd-kind-icon">pubsub</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#relay" class="tsd-kind-icon">relay</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pconfig.html#transport" class="tsd-kind-icon">transport</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="dht" class="tsd-anchor"></a>
<h3>dht</h3>
<div class="tsd-signature tsd-kind-icon">dht<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="dhtoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DhtOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L89">src/index.js:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>dht module options</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nat" class="tsd-anchor"></a>
<h3>nat</h3>
<div class="tsd-signature tsd-kind-icon">nat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NatManagerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L90">src/index.js:90</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="peerdiscovery" class="tsd-anchor"></a>
<h3>peer<wbr>Discovery</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Discovery<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L91">src/index.js:91</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pubsub" class="tsd-anchor"></a>
<h3>pubsub</h3>
<div class="tsd-signature tsd-kind-icon">pubsub<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><a href="pubsublocaloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PubsubLocalOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">PubsubOptions</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L92">src/index.js:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>pubsub module options</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="relay" class="tsd-anchor"></a>
<h3>relay</h3>
<div class="tsd-signature tsd-kind-icon">relay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="relayoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelayOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L93">src/index.js:93</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transport" class="tsd-anchor"></a>
<h3>transport</h3>
<div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L94">src/index.js:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>transport options indexed by transport key</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#dht" class="tsd-kind-icon">dht</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#nat" class="tsd-kind-icon">nat</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#peerdiscovery" class="tsd-kind-icon">peer<wbr>Discovery</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#pubsub" class="tsd-kind-icon">pubsub</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#relay" class="tsd-kind-icon">relay</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pconfig.html#transport" class="tsd-kind-icon">transport</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,341 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pModules | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="libp2pmodules.html">Libp2pModules</a>
</li>
</ul>
<h1>Interface Libp2pModules</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">Libp2pModules</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#connencryption" class="tsd-kind-icon">conn<wbr>Encryption</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#connprotector" class="tsd-kind-icon">conn<wbr>Protector</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#contentrouting" class="tsd-kind-icon">content<wbr>Routing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#dht" class="tsd-kind-icon">dht</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#peerdiscovery" class="tsd-kind-icon">peer<wbr>Discovery</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#pubsub" class="tsd-kind-icon">pubsub</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#streammuxer" class="tsd-kind-icon">stream<wbr>Muxer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2pmodules.html#transport" class="tsd-kind-icon">transport</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="connencryption" class="tsd-anchor"></a>
<h3>conn<wbr>Encryption</h3>
<div class="tsd-signature tsd-kind-icon">conn<wbr>Encryption<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Crypto</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L99">src/index.js:99</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="connprotector" class="tsd-anchor"></a>
<h3>conn<wbr>Protector</h3>
<div class="tsd-signature tsd-kind-icon">conn<wbr>Protector<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Protector</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L105">src/index.js:105</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="contentrouting" class="tsd-anchor"></a>
<h3>content<wbr>Routing</h3>
<div class="tsd-signature tsd-kind-icon">content<wbr>Routing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ContentRouting</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L102">src/index.js:102</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dht" class="tsd-anchor"></a>
<h3>dht</h3>
<div class="tsd-signature tsd-kind-icon">dht<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L103">src/index.js:103</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="peerdiscovery" class="tsd-anchor"></a>
<h3>peer<wbr>Discovery</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Discovery<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PeerDiscovery</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L100">src/index.js:100</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="peerrouting" class="tsd-anchor"></a>
<h3>peer<wbr>Routing</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Routing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PeerRouting</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L101">src/index.js:101</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pubsub" class="tsd-anchor"></a>
<h3>pubsub</h3>
<div class="tsd-signature tsd-kind-icon">pubsub<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PubsubBaseProtocol</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L104">src/index.js:104</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="streammuxer" class="tsd-anchor"></a>
<h3>stream<wbr>Muxer</h3>
<div class="tsd-signature tsd-kind-icon">stream<wbr>Muxer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MuxerFactory</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L98">src/index.js:98</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transport" class="tsd-anchor"></a>
<h3>transport</h3>
<div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransportFactory</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L97">src/index.js:97</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#connencryption" class="tsd-kind-icon">conn<wbr>Encryption</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#connprotector" class="tsd-kind-icon">conn<wbr>Protector</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#contentrouting" class="tsd-kind-icon">content<wbr>Routing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#dht" class="tsd-kind-icon">dht</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#peerdiscovery" class="tsd-kind-icon">peer<wbr>Discovery</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#pubsub" class="tsd-kind-icon">pubsub</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#streammuxer" class="tsd-kind-icon">stream<wbr>Muxer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2pmodules.html#transport" class="tsd-kind-icon">transport</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,393 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="libp2poptions.html">Libp2pOptions</a>
</li>
</ul>
<h1>Interface Libp2pOptions</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">Libp2pOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#addresses" class="tsd-kind-icon">addresses</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#datastore" class="tsd-kind-icon">datastore</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#dialer" class="tsd-kind-icon">dialer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#host" class="tsd-kind-icon">host</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#keychain" class="tsd-kind-icon">keychain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#metrics" class="tsd-kind-icon">metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#modules" class="tsd-kind-icon">modules</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="libp2poptions.html#transportmanager" class="tsd-kind-icon">transport<wbr>Manager</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="addresses" class="tsd-anchor"></a>
<h3>addresses</h3>
<div class="tsd-signature tsd-kind-icon">addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AddressManagerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L109">src/index.js:109</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="libp2pconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">Libp2pConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L119">src/index.js:119</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="connectionmanager" class="tsd-anchor"></a>
<h3>connection<wbr>Manager</h3>
<div class="tsd-signature tsd-kind-icon">connection<wbr>Manager<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ConnectionManagerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L110">src/index.js:110</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="datastore" class="tsd-anchor"></a>
<h3>datastore</h3>
<div class="tsd-signature tsd-kind-icon">datastore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Datastore</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L111">src/index.js:111</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dialer" class="tsd-anchor"></a>
<h3>dialer</h3>
<div class="tsd-signature tsd-kind-icon">dialer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DialerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L112">src/index.js:112</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="host" class="tsd-anchor"></a>
<h3>host</h3>
<div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HostProperties</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L113">src/index.js:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>libp2p host</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="keychain" class="tsd-anchor"></a>
<h3>keychain</h3>
<div class="tsd-signature tsd-kind-icon">keychain<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><a href="keychainoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">KeychainOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">KeychainOptions</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L114">src/index.js:114</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="metrics" class="tsd-anchor"></a>
<h3>metrics</h3>
<div class="tsd-signature tsd-kind-icon">metrics<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><a href="metricsoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MetricsOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">MetricsOptions</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L115">src/index.js:115</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="modules" class="tsd-anchor"></a>
<h3>modules</h3>
<div class="tsd-signature tsd-kind-icon">modules<span class="tsd-signature-symbol">:</span> <a href="libp2pmodules.html" class="tsd-signature-type" data-tsd-kind="Interface">Libp2pModules</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L108">src/index.js:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>libp2p modules to use</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="peerrouting" class="tsd-anchor"></a>
<h3>peer<wbr>Routing</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Routing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PeerRoutingOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L116">src/index.js:116</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><a href="peerstoreoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStoreOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">PersistentPeerStoreOptions</span><span class="tsd-signature-symbol">)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L117">src/index.js:117</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transportmanager" class="tsd-anchor"></a>
<h3>transport<wbr>Manager</h3>
<div class="tsd-signature tsd-kind-icon">transport<wbr>Manager<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TransportManagerOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L118">src/index.js:118</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#addresses" class="tsd-kind-icon">addresses</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#datastore" class="tsd-kind-icon">datastore</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#dialer" class="tsd-kind-icon">dialer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#host" class="tsd-kind-icon">host</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#keychain" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#metrics" class="tsd-kind-icon">metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#modules" class="tsd-kind-icon">modules</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="libp2poptions.html#transportmanager" class="tsd-kind-icon">transport<wbr>Manager</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>MetricsOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="metricsoptions.html">MetricsOptions</a>
</li>
</ul>
<h1>Interface MetricsOptions</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">MetricsOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="metricsoptions.html#enabled" class="tsd-kind-icon">enabled</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L80">src/index.js:80</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="metricsoptions.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PeerStoreOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="peerstoreoptions.html">PeerStoreOptions</a>
</li>
</ul>
<h1>Interface PeerStoreOptions</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">PeerStoreOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="peerstoreoptions.html#persistence" class="tsd-kind-icon">persistence</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="persistence" class="tsd-anchor"></a>
<h3>persistence</h3>
<div class="tsd-signature tsd-kind-icon">persistence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L74">src/index.js:74</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="peerstoreoptions.html#persistence" class="tsd-kind-icon">persistence</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PubsubLocalOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="pubsublocaloptions.html">PubsubLocalOptions</a>
</li>
</ul>
<h1>Interface PubsubLocalOptions</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">PubsubLocalOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="pubsublocaloptions.html#enabled" class="tsd-kind-icon">enabled</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L77">src/index.js:77</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="pubsublocaloptions.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,271 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RandomWalkOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="randomwalkoptions.html">RandomWalkOptions</a>
</li>
</ul>
<h1>Interface RandomWalkOptions</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">RandomWalkOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="randomwalkoptions.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="randomwalkoptions.html#interval" class="tsd-kind-icon">interval</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="randomwalkoptions.html#queriesperperiod" class="tsd-kind-icon">queries<wbr>Per<wbr>Period</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="randomwalkoptions.html#timeout" class="tsd-kind-icon">timeout</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L60">src/index.js:60</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="interval" class="tsd-anchor"></a>
<h3>interval</h3>
<div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L62">src/index.js:62</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="queriesperperiod" class="tsd-anchor"></a>
<h3>queries<wbr>Per<wbr>Period</h3>
<div class="tsd-signature tsd-kind-icon">queries<wbr>Per<wbr>Period<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L61">src/index.js:61</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="timeout" class="tsd-anchor"></a>
<h3>timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L63">src/index.js:63</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="randomwalkoptions.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="randomwalkoptions.html#interval" class="tsd-kind-icon">interval</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="randomwalkoptions.html#queriesperperiod" class="tsd-kind-icon">queries<wbr>Per<wbr>Period</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="randomwalkoptions.html#timeout" class="tsd-kind-icon">timeout</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>

View File

@ -0,0 +1,271 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RelayOptions | libp2p - v0.31.0-rc.0</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.0</a>
</li>
<li>
<a href="relayoptions.html">RelayOptions</a>
</li>
</ul>
<h1>Interface RelayOptions</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">RelayOptions</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="relayoptions.html#advertise" class="tsd-kind-icon">advertise</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="relayoptions.html#autorelay" class="tsd-kind-icon">auto<wbr>Relay</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="relayoptions.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="relayoptions.html#hop" class="tsd-kind-icon">hop</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="advertise" class="tsd-anchor"></a>
<h3>advertise</h3>
<div class="tsd-signature tsd-kind-icon">advertise<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RelayAdvertiseOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L84">src/index.js:84</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="autorelay" class="tsd-anchor"></a>
<h3>auto<wbr>Relay</h3>
<div class="tsd-signature tsd-kind-icon">auto<wbr>Relay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AutoRelayOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L86">src/index.js:86</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L83">src/index.js:83</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hop" class="tsd-anchor"></a>
<h3>hop</h3>
<div class="tsd-signature tsd-kind-icon">hop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HopOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L85">src/index.js:85</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/libp2p.html" class="tsd-kind-icon">Libp2p</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="createoptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="dhtoptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="handlerprops.html" class="tsd-kind-icon">Handler<wbr>Props</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="keychainoptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pconfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2pmodules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="libp2poptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="metricsoptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="peerstoreoptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="pubsublocaloptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="randomwalkoptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="relayoptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="relayoptions.html#advertise" class="tsd-kind-icon">advertise</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="relayoptions.html#autorelay" class="tsd-kind-icon">auto<wbr>Relay</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="relayoptions.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="relayoptions.html#hop" class="tsd-kind-icon">hop</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="constructoroptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#contentroutingmodule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#datastore" class="tsd-kind-icon">Datastore</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerdiscoverymodule" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#peerroutingmodule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#protector" class="tsd-kind-icon">Protector</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#pubsuboptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</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-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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method 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>
</body>
</html>