js-libp2p/globals.html

458 lines
22 KiB
HTML
Raw Normal View History

2020-12-10 15:50:24 +01:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
2020-12-11 18:28:40 +01:00
<title>libp2p - v0.30.0-rc.1</title>
<meta name="description" content="Documentation for libp2p - v0.30.0-rc.1">
2020-12-10 15:50:24 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
<style>
.toolbar-icon {
display: inline-block;
vertical-align: middle;
margin-left: 10px;
cursor: pointer;
}
.toolbar-icon-search {
box-sizing: border-box;
position: absolute;
overflow: hidden;
right: -40px;
width: 40px;
height: 40px;
display: flex;
justify-content: center;
align-items: center;
@media (min-width: 901px){
display: none
}
}
@media (min-width: 901px){
.toolbar-icon-menu {
display: none
}
.toolbar-icon-options {
display: none
}
}
.gg-menu {
transform: scale(var(--ggs,1))
}
.gg-menu,
.gg-menu::after,
.gg-menu::before {
box-sizing: border-box;
position: relative;
display: block;
width: 20px;
height: 2px;
border-radius: 3px;
background: currentColor
}
.gg-menu::after,
.gg-menu::before {
content: "";
position: absolute;
top: -6px
}
.gg-menu::after {
top: 6px
}
.gg-options {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 10px;
height: 2px;
box-shadow:
-3px 4px 0 0,
3px -4px 0 0
}
.gg-options::after,
.gg-options::before {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
width: 8px;
height: 8px;
border: 2px solid;
border-radius: 100%
}
.gg-options::before {
top: -7px;
left: -4px
}
.gg-options::after {
bottom: -7px;
right: -4px
}
.gg-search {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 16px;
height: 16px;
border: 2px solid;
border-radius: 100%;
margin-left: -4px;
margin-top: -4px
}
.gg-search::after {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
border-radius: 3px;
width: 2px;
height: 8px;
background: currentColor;
transform: rotate(-45deg);
top: 10px;
left: 12px
}
</style>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
2020-12-11 18:28:40 +01:00
<a href="index.html" class="title">libp2p - v0.30.0-rc.1</a>
2020-12-10 15:50:24 +01:00
</div>
<div class="table-cell" id="tsd-widgets">
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
</ul>
2020-12-11 18:28:40 +01:00
<h1>libp2p - v0.30.0-rc.1</h1>
2020-12-10 15:50:24 +01:00
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-module"><a href="modules/__libp2p_.html" class="tsd-kind-icon">&quot;libp2p&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_address_manager_index_.html" class="tsd-kind-icon">&quot;address-<wbr>manager/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_auto_relay_.html" class="tsd-kind-icon">&quot;circuit/auto-<wbr>relay&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_circuit_hop_.html" class="tsd-kind-icon">&quot;circuit/circuit/hop&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_circuit_stop_.html" class="tsd-kind-icon">&quot;circuit/circuit/stop&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_circuit_stream_handler_.html" class="tsd-kind-icon">&quot;circuit/circuit/stream-<wbr>handler&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_circuit_utils_.html" class="tsd-kind-icon">&quot;circuit/circuit/utils&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_constants_.html" class="tsd-kind-icon">&quot;circuit/constants&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_index_.html" class="tsd-kind-icon">&quot;circuit/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_listener_.html" class="tsd-kind-icon">&quot;circuit/listener&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_multicodec_.html" class="tsd-kind-icon">&quot;circuit/multicodec&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_protocol_index_.html" class="tsd-kind-icon">&quot;circuit/protocol/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_transport_.html" class="tsd-kind-icon">&quot;circuit/transport&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_circuit_utils_.html" class="tsd-kind-icon">&quot;circuit/utils&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_config_.html" class="tsd-kind-icon">&quot;config&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_connection_manager_index_.html" class="tsd-kind-icon">&quot;connection-<wbr>manager/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_connection_manager_latency_monitor_.html" class="tsd-kind-icon">&quot;connection-<wbr>manager/latency-<wbr>monitor&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_connection_manager_visibility_change_emitter_.html" class="tsd-kind-icon">&quot;connection-<wbr>manager/visibility-<wbr>change-<wbr>emitter&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_constants_.html" class="tsd-kind-icon">&quot;constants&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_content_routing_.html" class="tsd-kind-icon">&quot;content-<wbr>routing&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_dialer_dial_request_.html" class="tsd-kind-icon">&quot;dialer/dial-<wbr>request&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_dialer_index_.html" class="tsd-kind-icon">&quot;dialer/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_errors_.html" class="tsd-kind-icon">&quot;errors&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_get_peer_.html" class="tsd-kind-icon">&quot;get-<wbr>peer&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_identify_consts_.html" class="tsd-kind-icon">&quot;identify/consts&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_identify_index_.html" class="tsd-kind-icon">&quot;identify/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_identify_message_.html" class="tsd-kind-icon">&quot;identify/message&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_insecure_plaintext_.html" class="tsd-kind-icon">&quot;insecure/plaintext&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_insecure_proto_.html" class="tsd-kind-icon">&quot;insecure/proto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_keychain_cms_.html" class="tsd-kind-icon">&quot;keychain/cms&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_keychain_index_.html" class="tsd-kind-icon">&quot;keychain/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_keychain_util_.html" class="tsd-kind-icon">&quot;keychain/util&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_metrics_index_.html" class="tsd-kind-icon">&quot;metrics/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_metrics_old_peers_.html" class="tsd-kind-icon">&quot;metrics/old-<wbr>peers&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_metrics_stats_.html" class="tsd-kind-icon">&quot;metrics/stats&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_routing_.html" class="tsd-kind-icon">&quot;peer-<wbr>routing&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_address_book_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/address-<wbr>book&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_book_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/book&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_index_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_key_book_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/key-<wbr>book&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_metadata_book_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/metadata-<wbr>book&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_persistent_consts_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/persistent/consts&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_persistent_index_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/persistent/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_persistent_pb_address_book_proto_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/persistent/pb/address-<wbr>book.proto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_persistent_pb_proto_book_proto_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/persistent/pb/proto-<wbr>book.proto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_peer_store_proto_book_.html" class="tsd-kind-icon">&quot;peer-<wbr>store/proto-<wbr>book&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_ping_constants_.html" class="tsd-kind-icon">&quot;ping/constants&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_ping_index_.html" class="tsd-kind-icon">&quot;ping/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_ping_util_.html" class="tsd-kind-icon">&quot;ping/util&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_pnet_crypto_.html" class="tsd-kind-icon">&quot;pnet/crypto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_pnet_errors_.html" class="tsd-kind-icon">&quot;pnet/errors&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_pnet_index_.html" class="tsd-kind-icon">&quot;pnet/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_pnet_key_generator_.html" class="tsd-kind-icon">&quot;pnet/key-<wbr>generator&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_pubsub_adapter_.html" class="tsd-kind-icon">&quot;pubsub-<wbr>adapter&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_envelope_envelope_proto_.html" class="tsd-kind-icon">&quot;record/envelope/envelope.proto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_envelope_index_.html" class="tsd-kind-icon">&quot;record/envelope/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_peer_record_consts_.html" class="tsd-kind-icon">&quot;record/peer-<wbr>record/consts&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_peer_record_index_.html" class="tsd-kind-icon">&quot;record/peer-<wbr>record/index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_peer_record_peer_record_proto_.html" class="tsd-kind-icon">&quot;record/peer-<wbr>record/peer-<wbr>record.proto&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_record_utils_.html" class="tsd-kind-icon">&quot;record/utils&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_registrar_.html" class="tsd-kind-icon">&quot;registrar&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_transport_manager_.html" class="tsd-kind-icon">&quot;transport-<wbr>manager&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_types_.html" class="tsd-kind-icon">&quot;types&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_upgrader_.html" class="tsd-kind-icon">&quot;upgrader&quot;</a></li>
</ul>
</section>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" tsd-kind-module">
<a href="modules/__libp2p_.html">libp2p</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_address_manager_index_.html">address-manager/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_auto_relay_.html">circuit/auto-relay</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_circuit_hop_.html">circuit/circuit/hop</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_circuit_stop_.html">circuit/circuit/stop</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_circuit_stream_handler_.html">circuit/circuit/stream-handler</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_circuit_utils_.html">circuit/circuit/utils</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_constants_.html">circuit/constants</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_index_.html">circuit/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_listener_.html">circuit/listener</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_multicodec_.html">circuit/multicodec</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_protocol_index_.html">circuit/protocol/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_transport_.html">circuit/transport</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_circuit_utils_.html">circuit/utils</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_config_.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_connection_manager_index_.html">connection-manager/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_connection_manager_latency_monitor_.html">connection-manager/latency-monitor</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_connection_manager_visibility_change_emitter_.html">connection-manager/visibility-change-emitter</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_constants_.html">constants</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_content_routing_.html">content-routing</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_dialer_dial_request_.html">dialer/dial-request</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_dialer_index_.html">dialer/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_errors_.html">errors</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_get_peer_.html">get-peer</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_identify_consts_.html">identify/consts</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_identify_index_.html">identify/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_identify_message_.html">identify/message</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_insecure_plaintext_.html">insecure/plaintext</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_insecure_proto_.html">insecure/proto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_keychain_cms_.html">keychain/cms</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_keychain_index_.html">keychain/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_keychain_util_.html">keychain/util</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_metrics_index_.html">metrics/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_metrics_old_peers_.html">metrics/old-peers</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_metrics_stats_.html">metrics/stats</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_routing_.html">peer-routing</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_address_book_.html">peer-store/address-book</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_book_.html">peer-store/book</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_index_.html">peer-store/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_key_book_.html">peer-store/key-book</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_metadata_book_.html">peer-store/metadata-book</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_persistent_consts_.html">peer-store/persistent/consts</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_persistent_index_.html">peer-store/persistent/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_persistent_pb_address_book_proto_.html">peer-store/persistent/pb/address-book.proto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_persistent_pb_proto_book_proto_.html">peer-store/persistent/pb/proto-book.proto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_peer_store_proto_book_.html">peer-store/proto-book</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_ping_constants_.html">ping/constants</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_ping_index_.html">ping/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_ping_util_.html">ping/util</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_pnet_crypto_.html">pnet/crypto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_pnet_errors_.html">pnet/errors</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_pnet_index_.html">pnet/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_pnet_key_generator_.html">pnet/key-generator</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_pubsub_adapter_.html">pubsub-adapter</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_envelope_envelope_proto_.html">record/envelope/envelope.proto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_envelope_index_.html">record/envelope/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_peer_record_consts_.html">record/peer-record/consts</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_peer_record_index_.html">record/peer-record/index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_peer_record_peer_record_proto_.html">record/peer-record/peer-record.proto</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_record_utils_.html">record/utils</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_registrar_.html">registrar</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_transport_manager_.html">transport-manager</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_types_.html">types</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_upgrader_.html">upgrader</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>