mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-06-21 21:11:34 +00:00
chore: update documentation
This commit is contained in:
Vasco Santos
78
modules.html
78
modules.html
@ -3,8 +3,8 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>libp2p - v0.31.0-rc.5</title>
|
||||
<meta name="description" content="Documentation for libp2p - v0.31.0-rc.5">
|
||||
<title>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">
|
||||
@ -50,7 +50,7 @@
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<h1>libp2p - v0.31.0-rc.5</h1>
|
||||
<h1>libp2p - v0.31.0-rc.6</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
@ -92,8 +92,6 @@
|
||||
<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#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>
|
||||
<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>
|
||||
@ -149,68 +147,6 @@
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
|
||||
<a name="dhtselectors" class="tsd-anchor"></a>
|
||||
<h3>Dht<wbr>Selectors</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Dht<wbr>Selectors<span class="tsd-signature-symbol">:</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#L59">src/index.js:59</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">function (Uint8Array, Uint8Array[]): number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
|
||||
<a name="dhtvalidators" class="tsd-anchor"></a>
|
||||
<h3>Dht<wbr>Validators</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Dht<wbr>Validators<span class="tsd-signature-symbol">:</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#L60">src/index.js:60</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-index-signature">
|
||||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">{ </span>func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>key: <span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>value: <span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
|
||||
<a name="muxedstream" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Stream</h3>
|
||||
@ -357,12 +293,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>
|
||||
|
||||
Reference in New Issue
Block a user