js-libp2p/interfaces/Libp2pModules.html

338 lines
17 KiB
HTML
Raw Normal View History

2021-08-20 09:25:06 +02:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
2021-12-18 07:55:19 +01:00
<title>Libp2pModules | libp2p - v0.35.6</title>
<meta name="description" content="Documentation for libp2p - v0.35.6">
2021-08-20 09:25:06 +02:00
<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>
2021-12-18 07:55:19 +01:00
<a href="../index.html" class="title">libp2p - v0.35.6</a>
2021-08-20 09:25:06 +02:00
</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>
2021-12-18 07:55:19 +01:00
<a href="../modules.html">libp2p - v0.35.6</a>
2021-08-20 09:25:06 +02:00
</li>
<li>
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html">Libp2pModules</a>
2021-08-20 09:25:06 +02:00
</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">
2021-11-25 16:49:37 +00:00
<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>
2021-08-20 09:25:06 +02:00
</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">
2021-11-25 16:49:37 +00:00
<a name="connEncryption" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L95">src/index.js:95</a></li>
2021-08-20 09:25:06 +02:00
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a name="connProtector" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L101">src/index.js:101</a></li>
2021-08-20 09:25:06 +02:00
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a name="contentRouting" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L98">src/index.js:98</a></li>
2021-08-20 09:25:06 +02:00
</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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L99">src/index.js:99</a></li>
2021-08-20 09:25:06 +02:00
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a name="peerDiscovery" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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">PeerDiscoveryFactory</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L96">src/index.js:96</a></li>
2021-08-20 09:25:06 +02:00
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a name="peerRouting" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L97">src/index.js:97</a></li>
2021-08-20 09:25:06 +02:00
</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><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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L100">src/index.js:100</a></li>
2021-08-20 09:25:06 +02:00
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a name="streamMuxer" class="tsd-anchor"></a>
2021-08-20 09:25:06 +02:00
<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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L94">src/index.js:94</a></li>
2021-08-20 09:25:06 +02:00
</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>
2021-12-13 09:03:47 +00:00
<li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/master/src/index.js#L93">src/index.js:93</a></li>
2021-08-20 09:25:06 +02:00
</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">
2021-11-25 16:49:37 +00:00
<a href="../classes/Libp2p.html" class="tsd-kind-icon">Libp2p</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="CreateOptions.html" class="tsd-kind-icon">Create<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="DhtOptions.html" class="tsd-kind-icon">Dht<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="HandlerProps.html" class="tsd-kind-icon">Handler<wbr>Props</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="KeychainOptions.html" class="tsd-kind-icon">Keychain<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="Libp2pConfig.html" class="tsd-kind-icon">Libp2p<wbr>Config</a>
2021-08-20 09:25:06 +02:00
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
2021-08-20 09:25:06 +02:00
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#connEncryption" class="tsd-kind-icon">conn<wbr>Encryption</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#connProtector" class="tsd-kind-icon">conn<wbr>Protector</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#contentRouting" class="tsd-kind-icon">content<wbr>Routing</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#dht" class="tsd-kind-icon">dht</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#peerDiscovery" class="tsd-kind-icon">peer<wbr>Discovery</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#peerRouting" class="tsd-kind-icon">peer<wbr>Routing</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#pubsub" class="tsd-kind-icon">pubsub</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#streamMuxer" class="tsd-kind-icon">stream<wbr>Muxer</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
2021-11-25 16:49:37 +00:00
<a href="Libp2pModules.html#transport" class="tsd-kind-icon">transport</a>
2021-08-20 09:25:06 +02:00
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="Libp2pOptions.html" class="tsd-kind-icon">Libp2p<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="MetricsOptions.html" class="tsd-kind-icon">Metrics<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="PeerStoreOptions.html" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="PubsubLocalOptions.html" class="tsd-kind-icon">Pubsub<wbr>Local<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="RelayOptions.html" class="tsd-kind-icon">Relay<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="constructorOptions.html" class="tsd-kind-icon">constructor<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#Connection" class="tsd-kind-icon">Connection</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#ContentRoutingModule" class="tsd-kind-icon">Content<wbr>Routing<wbr>Module</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#Crypto" class="tsd-kind-icon">Crypto</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#Datastore" class="tsd-kind-icon">Datastore</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#MuxedStream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#MuxerFactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#PeerDiscoveryFactory" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Factory</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#PeerRoutingModule" class="tsd-kind-icon">Peer<wbr>Routing<wbr>Module</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#Protector" class="tsd-kind-icon">Protector</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#Pubsub" class="tsd-kind-icon">Pubsub</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#PubsubOptions" class="tsd-kind-icon">Pubsub<wbr>Options</a>
2021-08-20 09:25:06 +02:00
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
2021-11-25 16:49:37 +00:00
<a href="../modules.html#TransportFactory" class="tsd-kind-icon">Transport<wbr>Factory</a>
2021-08-20 09:25:06 +02:00
</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>