fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-05-19 22:01:19 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
achingbrain 2021-12-13 09:03:47 +00:00
parent 62fded5067
commit ecd918e485
17 changed files with 152 additions and 498 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
assets/js/search.js
View File

File diff suppressed because one or more lines are too long

124
classes/Libp2p.html
View File

File diff suppressed because one or more lines are too long

11
index.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="index.html" class="title">libp2p - v0.35.3</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.35.2</h1>
<h1>libp2p - v0.35.3</h1>
</div>
</div>
</header>
@ -566,9 +566,6 @@
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/PubsubLocalOptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/RandomWalkOptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/RelayOptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>

13
interfaces/CreateOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CreateOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>CreateOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="CreateOptions.html">CreateOptions</a>
@ -94,7 +94,7 @@
<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#L128">src/index.js:128</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L121">src/index.js:121</a></li>
</ul>
</aside>
</section>
@ -152,9 +152,6 @@
<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>

35
interfaces/DhtOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DhtOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>DhtOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="DhtOptions.html">DhtOptions</a>
@ -83,7 +83,6 @@
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DhtOptions.html#clientMode" class="tsd-kind-icon">client<wbr>Mode</a></li>
<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>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DhtOptions.html#selectors" class="tsd-kind-icon">selectors</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DhtOptions.html#validators" class="tsd-kind-icon">validators</a></li>
</ul>
@ -99,7 +98,7 @@
<div class="tsd-signature tsd-kind-icon">client<wbr>Mode<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#L69">src/index.js:69</a></li>
<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>
@ -109,7 +108,7 @@
<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>
<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>
@ -119,17 +118,7 @@
<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>
<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>
@ -139,7 +128,7 @@
<div class="tsd-signature tsd-kind-icon">selectors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DhtSelectors</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L70">src/index.js:70</a></li>
<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>
@ -149,7 +138,7 @@
<div class="tsd-signature tsd-kind-icon">validators<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DhtValidators</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>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L64">src/index.js:64</a></li>
</ul>
</aside>
</section>
@ -185,9 +174,6 @@
<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>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DhtOptions.html#selectors" class="tsd-kind-icon">selectors</a>
</li>
@ -222,9 +208,6 @@
<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>

11
interfaces/HandlerProps.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>HandlerProps | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>HandlerProps | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="HandlerProps.html">HandlerProps</a>
@ -180,9 +180,6 @@
<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>

13
interfaces/KeychainOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>KeychainOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>KeychainOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="KeychainOptions.html">KeychainOptions</a>
@ -94,7 +94,7 @@
<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#L74">src/index.js:74</a></li>
<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>
@ -152,9 +152,6 @@
<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>

23
interfaces/Libp2pConfig.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pConfig | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>Libp2pConfig | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="Libp2pConfig.html">Libp2pConfig</a>
@ -99,7 +99,7 @@
<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#L92">src/index.js:92</a></li>
<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>
<div class="tsd-comment tsd-typography">
@ -114,7 +114,7 @@
<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#L93">src/index.js:93</a></li>
<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>
@ -124,7 +124,7 @@
<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#L94">src/index.js:94</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L87">src/index.js:87</a></li>
</ul>
</aside>
</section>
@ -134,7 +134,7 @@
<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#L95">src/index.js:95</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L88">src/index.js:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -149,7 +149,7 @@
<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#L96">src/index.js:96</a></li>
<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>
</section>
@ -159,7 +159,7 @@
<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#L97">src/index.js:97</a></li>
<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>
<div class="tsd-comment tsd-typography">
@ -237,9 +237,6 @@
<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>

29
interfaces/Libp2pModules.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pModules | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>Libp2pModules | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="Libp2pModules.html">Libp2pModules</a>
@ -102,7 +102,7 @@
<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#L102">src/index.js:102</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L95">src/index.js:95</a></li>
</ul>
</aside>
</section>
@ -112,7 +112,7 @@
<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#L108">src/index.js:108</a></li>
<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>
@ -122,7 +122,7 @@
<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#L105">src/index.js:105</a></li>
<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>
@ -132,7 +132,7 @@
<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#L106">src/index.js:106</a></li>
<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>
@ -142,7 +142,7 @@
<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">PeerDiscoveryFactory</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#L103">src/index.js:103</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L96">src/index.js:96</a></li>
</ul>
</aside>
</section>
@ -152,7 +152,7 @@
<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#L104">src/index.js:104</a></li>
<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>
@ -162,7 +162,7 @@
<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><span class="tsd-signature-symbol">new </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">PubsubBaseProtocol</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#L107">src/index.js:107</a></li>
<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>
@ -172,7 +172,7 @@
<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#L101">src/index.js:101</a></li>
<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>
</section>
@ -182,7 +182,7 @@
<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#L100">src/index.js:100</a></li>
<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>
@ -264,9 +264,6 @@
<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>

35
interfaces/Libp2pOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Libp2pOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>Libp2pOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="Libp2pOptions.html">Libp2pOptions</a>
@ -105,7 +105,7 @@
<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#L112">src/index.js:112</a></li>
<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>
@ -115,7 +115,7 @@
<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#L122">src/index.js:122</a></li>
<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>
@ -125,7 +125,7 @@
<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#L113">src/index.js:113</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L106">src/index.js:106</a></li>
</ul>
</aside>
</section>
@ -135,7 +135,7 @@
<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#L114">src/index.js:114</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L107">src/index.js:107</a></li>
</ul>
</aside>
</section>
@ -145,7 +145,7 @@
<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#L115">src/index.js:115</a></li>
<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>
</section>
@ -155,7 +155,7 @@
<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#L116">src/index.js:116</a></li>
<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>
<div class="tsd-comment tsd-typography">
@ -170,7 +170,7 @@
<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#L117">src/index.js:117</a></li>
<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>
@ -180,7 +180,7 @@
<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#L118">src/index.js:118</a></li>
<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>
@ -190,7 +190,7 @@
<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#L111">src/index.js:111</a></li>
<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>
<div class="tsd-comment tsd-typography">
@ -205,7 +205,7 @@
<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#L119">src/index.js:119</a></li>
<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>
@ -215,7 +215,7 @@
<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#L120">src/index.js:120</a></li>
<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>
</section>
@ -225,7 +225,7 @@
<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#L121">src/index.js:121</a></li>
<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>
@ -316,9 +316,6 @@
<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>

13
interfaces/MetricsOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>MetricsOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>MetricsOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="MetricsOptions.html">MetricsOptions</a>
@ -94,7 +94,7 @@
<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#L83">src/index.js:83</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L76">src/index.js:76</a></li>
</ul>
</aside>
</section>
@ -152,9 +152,6 @@
<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>

13
interfaces/PeerStoreOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PeerStoreOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>PeerStoreOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="PeerStoreOptions.html">PeerStoreOptions</a>
@ -94,7 +94,7 @@
<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#L77">src/index.js:77</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L70">src/index.js:70</a></li>
</ul>
</aside>
</section>
@ -152,9 +152,6 @@
<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>

13
interfaces/PubsubLocalOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PubsubLocalOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>PubsubLocalOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="PubsubLocalOptions.html">PubsubLocalOptions</a>
@ -94,7 +94,7 @@
<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>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L73">src/index.js:73</a></li>
</ul>
</aside>
</section>
@ -152,9 +152,6 @@
</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>

271
interfaces/RandomWalkOptions.html
View File

@ -1,271 +0,0 @@
<!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.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<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.35.2</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.35.2</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#PeerDiscoveryFactory" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Factory</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>

19
interfaces/RelayOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RelayOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>RelayOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="RelayOptions.html">RelayOptions</a>
@ -97,7 +97,7 @@
<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#L87">src/index.js:87</a></li>
<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>
@ -107,7 +107,7 @@
<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#L89">src/index.js:89</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L82">src/index.js:82</a></li>
</ul>
</aside>
</section>
@ -117,7 +117,7 @@
<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#L86">src/index.js:86</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L79">src/index.js:79</a></li>
</ul>
</aside>
</section>
@ -127,7 +127,7 @@
<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#L88">src/index.js:88</a></li>
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L81">src/index.js:81</a></li>
</ul>
</aside>
</section>
@ -176,9 +176,6 @@
<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">

13
interfaces/constructorOptions.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>constructorOptions | libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>constructorOptions | libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="../index.html" class="title">libp2p - v0.35.3</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.35.2</a>
<a href="../modules.html">libp2p - v0.35.3</a>
</li>
<li>
<a href="constructorOptions.html">constructorOptions</a>
@ -94,7 +94,7 @@
<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#L125">src/index.js:125</a></li>
<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>
@ -143,9 +143,6 @@
<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>

12
modules.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>libp2p - v0.35.2</title>
<meta name="description" content="Documentation for libp2p - v0.35.2">
<title>libp2p - v0.35.3</title>
<meta name="description" content="Documentation for libp2p - v0.35.3">
<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.35.2</a>
<a href="index.html" class="title">libp2p - v0.35.3</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.35.2</h1>
<h1>libp2p - v0.35.3</h1>
</div>
</div>
</header>
@ -80,7 +80,6 @@
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/MetricsOptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/PeerStoreOptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/PubsubLocalOptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RandomWalkOptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelayOptions.html" class="tsd-kind-icon">Relay<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/constructorOptions.html" class="tsd-kind-icon">constructor<wbr>Options</a></li>
</ul>
@ -272,9 +271,6 @@
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/PubsubLocalOptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/RandomWalkOptions.html" class="tsd-kind-icon">Random<wbr>Walk<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/RelayOptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>