fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-06-24 06:21:32 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Vasco Santos
2021-04-22 10:09:10 +02:00
parent bf1c322449
commit 800af49b0d
17 changed files with 137 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
classes/libp2p.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2p | libp2p - v0.31.0-rc.5</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.5">
<title>Libp2p | libp2p - v0.31.0-rc.6</title>
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.6">
<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>
@ -23,7 +23,7 @@
<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.5</a>
<a href="../index.html" class="title">libp2p - v0.31.0-rc.6</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">libp2p - v0.31.0-rc.5</a>
<a href="../modules.html">libp2p - v0.31.0-rc.6</a>
</li>
<li>
<a href="libp2p.html">Libp2p</a>
@ -102,10 +102,10 @@
<dd><p>{boolean} [clientMode]</p>
</dd>
<dt>property</dt>
<dd><p>{DhtSelectors} [selectors]</p>
<dd><p>{import(&#39;libp2p-interfaces/src/types&#39;).DhtSelectors} [selectors]</p>
</dd>
<dt>property</dt>
<dd><p>{DhtValidators} [validators]</p>
<dd><p>{import(&#39;libp2p-interfaces/src/types&#39;).DhtValidators} [validators]</p>
</dd>
<dt>property</dt>
<dd><p>{Datastore} [datastore]</p>
@ -347,7 +347,7 @@
<aside class="tsd-sources">
<p>Overrides EventEmitter.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L156">src/index.js:156</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L153">src/index.js:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -617,7 +617,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L453">src/index.js:453</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L450">src/index.js:450</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -640,7 +640,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L524">src/index.js:524</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L521">src/index.js:521</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -669,7 +669,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L496">src/index.js:496</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L493">src/index.js:493</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -704,7 +704,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L697">src/index.js:697</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L694">src/index.js:694</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -736,7 +736,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L647">src/index.js:647</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L644">src/index.js:644</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -758,7 +758,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L679">src/index.js:679</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L676">src/index.js:676</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -800,7 +800,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L614">src/index.js:614</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L611">src/index.js:611</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@ -817,7 +817,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L718">src/index.js:718</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L715">src/index.js:715</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -888,7 +888,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L466">src/index.js:466</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L463">src/index.js:463</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -923,7 +923,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L481">src/index.js:481</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L478">src/index.js:478</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -967,7 +967,7 @@
<aside class="tsd-sources">
<p>Overrides EventEmitter.emit</p>
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L347">src/index.js:347</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L344">src/index.js:344</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1035,7 +1035,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L588">src/index.js:588</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L585">src/index.js:585</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1086,7 +1086,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L549">src/index.js:549</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L546">src/index.js:546</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1117,7 +1117,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L443">src/index.js:443</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L440">src/index.js:440</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4>
@ -1182,7 +1182,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L431">src/index.js:431</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L428">src/index.js:428</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1344,7 +1344,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L571">src/index.js:571</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L568">src/index.js:568</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1582,7 +1582,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L363">src/index.js:363</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L360">src/index.js:360</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1604,7 +1604,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L384">src/index.js:384</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L381">src/index.js:381</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1630,7 +1630,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L604">src/index.js:604</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L601">src/index.js:601</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1661,7 +1661,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L145">src/index.js:145</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L142">src/index.js:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -2063,12 +2063,6 @@
<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#dhtselectors" class="tsd-kind-icon">Dht<wbr>Selectors</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#dhtvalidators" class="tsd-kind-icon">Dht<wbr>Validators</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>