Files
js-libp2p/classes/__libp2p_.libp2p.html

1768 lines
114 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">
2021-01-18 17:14:51 +01:00
<title>Libp2p | libp2p - v0.30.1</title>
<meta name="description" content="Documentation for libp2p - v0.30.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>
2021-01-18 17:14:51 +01:00
<a href="../index.html" class="title">libp2p - v0.30.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">
<li>
<a href="../modules/__libp2p_.html">libp2p</a>
</li>
<li>
<a href="__libp2p_.libp2p.html">Libp2p</a>
</li>
</ul>
<h1>Class Libp2p</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>property</dt>
<dd><p>{boolean} persistence</p>
</dd>
<dt>property</dt>
<dd><p>{boolean} autoDial</p>
</dd>
<dt>property</dt>
<dd><p>{boolean} enabled</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./circuit&#39;).RelayAdvertiseOptions} advertise</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./circuit&#39;).HopOptions} hop</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./circuit&#39;).AutoRelayOptions} autoRelay</p>
</dd>
<dt>property</dt>
<dd><p>{Object} [dht] dht module options</p>
</dd>
<dt>property</dt>
<dd><p>{PeerDiscoveryOptions} [peerDiscovery]</p>
</dd>
<dt>property</dt>
<dd><p>{Pubsub} [pubsub] pubsub module options</p>
</dd>
<dt>property</dt>
<dd><p>{RelayOptions} [relay]</p>
</dd>
<dt>property</dt>
<dd><p>{Record&lt;string, Object&gt;} [transport] transport options indexed by transport key</p>
</dd>
<dt>property</dt>
<dd><p>{TransportFactory[]} transport</p>
</dd>
<dt>property</dt>
<dd><p>{MuxerFactory[]} streamMuxer</p>
</dd>
<dt>property</dt>
<dd><p>{Crypto[]} connEncryption</p>
</dd>
<dt>property</dt>
<dd><p>{Libp2pModules} modules libp2p modules to use</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./address-manager&#39;).AddressManagerOptions} [addresses]</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./connection-manager&#39;).ConnectionManagerOptions} [connectionManager]</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./dialer&#39;).DialerOptions} [dialer]</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./metrics&#39;).MetricsOptions} [metrics]</p>
</dd>
<dt>property</dt>
<dd><p>{Object} [keychain]</p>
</dd>
<dt>property</dt>
<dd><p>{import(&#39;./transport-manager&#39;).TransportManagerOptions} [transportManager]</p>
</dd>
<dt>property</dt>
<dd><p>{PeerStoreOptions &amp; import(&#39;./peer-store/persistent&#39;).PersistentPeerStoreOptions} [peerStore]</p>
</dd>
<dt>property</dt>
<dd><p>{Libp2pConfig} [config]</p>
</dd>
<dt>property</dt>
<dd><p>{PeerId} peerId</p>
</dd>
<dt>property</dt>
<dd><p>{PeerId} peerId</p>
</dd>
<dt>fires</dt>
<dd><p>Libp2p#error Emitted when an error occurs</p>
</dd>
<dt>fires</dt>
<dd><p>Libp2p#peer:discovery Emitted when a peer is discovered</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
2021-01-18 17:14:51 +01:00
<a href="../interfaces/_types_.eventemitter.html" class="tsd-signature-type">EventEmitter</a>
2020-12-10 15:50:24 +01:00
<ul class="tsd-hierarchy">
<li>
<span class="target">Libp2p</span>
</li>
</ul>
</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>References</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#connection" class="tsd-kind-icon">Connection</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#createoptions" class="tsd-kind-icon">Create<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#crypto" class="tsd-kind-icon">Crypto</a></li>
2021-01-18 17:14:51 +01:00
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#events" class="tsd-kind-icon">Events</a></li>
2020-12-10 15:50:24 +01:00
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#libp2pconfig" class="tsd-kind-icon">Libp2p<wbr>Config</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#libp2pmodules" class="tsd-kind-icon">Libp2p<wbr>Modules</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-kind-icon">Libp2p<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#peerdiscoveryoptions" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#peerstoreoptions" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#pubsub" class="tsd-kind-icon">Pubsub</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#relayoptions" class="tsd-kind-icon">Relay<wbr>Options</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="__libp2p_.libp2p.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Constructors</h3>
<ul class="tsd-index-list">
2021-01-18 17:14:51 +01:00
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#constructor" class="tsd-kind-icon">constructor</a></li>
2020-12-10 15:50:24 +01:00
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_config" class="tsd-kind-icon">_config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_dht" class="tsd-kind-icon">_dht</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_discovery" class="tsd-kind-icon">_discovery</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_isstarted" class="tsd-kind-icon">_is<wbr>Started</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_maybeconnect" class="tsd-kind-icon">_maybe<wbr>Connect</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_modules" class="tsd-kind-icon">_modules</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_ondidstart" class="tsd-kind-icon">_on<wbr>Did<wbr>Start</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_ondiscoverypeer" class="tsd-kind-icon">_on<wbr>Discovery<wbr>Peer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_options" class="tsd-kind-icon">_options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_setuppeerdiscovery" class="tsd-kind-icon">_setup<wbr>Peer<wbr>Discovery</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_transport" class="tsd-kind-icon">_transport</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#addressmanager" class="tsd-kind-icon">address<wbr>Manager</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#addresses" class="tsd-kind-icon">addresses</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#contentrouting" class="tsd-kind-icon">content<wbr>Routing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#datastore" class="tsd-kind-icon">datastore</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#dialer" class="tsd-kind-icon">dialer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#identifyservice" class="tsd-kind-icon">identify<wbr>Service</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#keychain" class="tsd-kind-icon">keychain</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#metrics" class="tsd-kind-icon">metrics</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#pubsub-1" class="tsd-kind-icon">pubsub</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#registrar" class="tsd-kind-icon">registrar</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#relay" class="tsd-kind-icon">relay</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#transportmanager" class="tsd-kind-icon">transport<wbr>Manager</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#upgrader" class="tsd-kind-icon">upgrader</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#connections" class="tsd-kind-icon">connections</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#multiaddrs" class="tsd-kind-icon">multiaddrs</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#_onstarting" class="tsd-kind-icon">_on<wbr>Starting</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#dial" class="tsd-kind-icon">dial</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#dialprotocol" class="tsd-kind-icon">dial<wbr>Protocol</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#emit" class="tsd-kind-icon">emit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#handle" class="tsd-kind-icon">handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#hangup" class="tsd-kind-icon">hang<wbr>Up</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#isstarted" class="tsd-kind-icon">is<wbr>Started</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#listeners" class="tsd-kind-icon">listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#loadkeychain" class="tsd-kind-icon">load<wbr>Keychain</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#off" class="tsd-kind-icon">off</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#on" class="tsd-kind-icon">on</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#once" class="tsd-kind-icon">once</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#ping" class="tsd-kind-icon">ping</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported"><a href="__libp2p_.libp2p.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-not-exported"><a href="__libp2p_.libp2p.html#unhandle" class="tsd-kind-icon">unhandle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-not-exported"><a href="__libp2p_.libp2p.html#create" class="tsd-kind-icon">create</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>References</h2>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="connection" class="tsd-anchor"></a>
<h3>Connection</h3>
Re-exports <a href="../modules/_connection_manager_index_.html#connection">Connection</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="createoptions" class="tsd-anchor"></a>
<h3>Create<wbr>Options</h3>
Re-exports <a href="../modules/__libp2p_.html#createoptions">CreateOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="crypto" class="tsd-anchor"></a>
<h3>Crypto</h3>
Re-exports <a href="../modules/_upgrader_.html#crypto">Crypto</a>
</section>
2021-01-18 17:14:51 +01:00
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="events" class="tsd-anchor"></a>
<h3>Events</h3>
Re-exports <a href="../modules/_peer_store_index_.html#events">Events</a>
</section>
2020-12-10 15:50:24 +01:00
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="libp2pconfig" class="tsd-anchor"></a>
<h3>Libp2p<wbr>Config</h3>
Re-exports <a href="../modules/__libp2p_.html#libp2pconfig">Libp2pConfig</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="libp2pmodules" class="tsd-anchor"></a>
<h3>Libp2p<wbr>Modules</h3>
Re-exports <a href="../modules/__libp2p_.html#libp2pmodules">Libp2pModules</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="libp2poptions" class="tsd-anchor"></a>
<h3>Libp2p<wbr>Options</h3>
Re-exports <a href="../modules/__libp2p_.html#libp2poptions">Libp2pOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="multiaddr" class="tsd-anchor"></a>
<h3>Multiaddr</h3>
Re-exports <a href="../modules/_address_manager_index_.html#multiaddr">Multiaddr</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="muxedstream" class="tsd-anchor"></a>
<h3>Muxed<wbr>Stream</h3>
Re-exports <a href="../modules/_upgrader_.html#muxedstream">MuxedStream</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="muxerfactory" class="tsd-anchor"></a>
<h3>Muxer<wbr>Factory</h3>
Re-exports <a href="../modules/_upgrader_.html#muxerfactory">MuxerFactory</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="peerdiscoveryoptions" class="tsd-anchor"></a>
<h3>Peer<wbr>Discovery<wbr>Options</h3>
Re-exports <a href="../modules/__libp2p_.html#peerdiscoveryoptions">PeerDiscoveryOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="peerstoreoptions" class="tsd-anchor"></a>
<h3>Peer<wbr>Store<wbr>Options</h3>
Re-exports <a href="../modules/__libp2p_.html#peerstoreoptions">PeerStoreOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="pubsub" class="tsd-anchor"></a>
<h3>Pubsub</h3>
Re-exports <a href="../modules/__libp2p_.html#pubsub-1">Pubsub</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="relayoptions" class="tsd-anchor"></a>
<h3>Relay<wbr>Options</h3>
Re-exports <a href="../modules/__libp2p_.html#relayoptions">RelayOptions</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="transportfactory" class="tsd-anchor"></a>
<h3>Transport<wbr>Factory</h3>
Re-exports <a href="../modules/_transport_manager_.html#transportfactory">TransportFactory</a>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Constructors</h2>
2021-01-18 17:14:51 +01:00
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
2020-12-10 15:50:24 +01:00
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
2021-01-18 17:14:51 +01:00
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
2020-12-10 15:50:24 +01:00
<li class="tsd-signature tsd-kind-icon">new <wbr>Libp2p<span class="tsd-signature-symbol">(</span>_options<span class="tsd-signature-symbol">: </span><a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-signature-type">Libp2pOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="__libp2p_.libp2p.html" class="tsd-signature-type">Libp2p</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Libp2p node.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>_options: <a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-signature-type">Libp2pOptions</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="__libp2p_.libp2p.html" class="tsd-signature-type">Libp2p</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="_config" class="tsd-anchor"></a>
<h3>_config</h3>
<div class="tsd-signature tsd-kind-icon">_config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<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">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="_discovery" class="tsd-anchor"></a>
<h3>_discovery</h3>
<div class="tsd-signature tsd-kind-icon">_discovery<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</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></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="_isstarted" class="tsd-anchor"></a>
<h3>_is<wbr>Started</h3>
<div class="tsd-signature tsd-kind-icon">_is<wbr>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a name="_maybeconnect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _maybe<wbr>Connect</h3>
<div class="tsd-signature tsd-kind-icon">_maybe<wbr>Connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Will dial to the given <code>peerId</code> if the current number of
connected peers is less than the configured <code>ConnectionManager</code>
minConnections.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="_modules" class="tsd-anchor"></a>
<h3>_modules</h3>
<div class="tsd-signature tsd-kind-icon">_modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a name="_ondidstart" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _on<wbr>Did<wbr>Start</h3>
<div class="tsd-signature tsd-kind-icon">_on<wbr>Did<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Called when libp2p has started and before it returns</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a name="_ondiscoverypeer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _on<wbr>Discovery<wbr>Peer</h3>
<div class="tsd-signature tsd-kind-icon">_on<wbr>Discovery<wbr>Peer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Called whenever peer discovery services emit <code>peer</code> events.
Known peers may be emitted.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="_options" class="tsd-anchor"></a>
<h3>_options</h3>
<div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a name="_setuppeerdiscovery" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _setup<wbr>Peer<wbr>Discovery</h3>
<div class="tsd-signature tsd-kind-icon">_setup<wbr>Peer<wbr>Discovery<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initializes and starts peer discovery services</p>
</div>
<dl class="tsd-comment-tags">
<dt>async</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<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">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="addressmanager" class="tsd-anchor"></a>
<h3>address<wbr>Manager</h3>
<div class="tsd-signature tsd-kind-icon">address<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="_address_manager_index_.addressmanager.html" class="tsd-signature-type">AddressManager</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="addresses" class="tsd-anchor"></a>
<h3>addresses</h3>
<div class="tsd-signature tsd-kind-icon">addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="connectionmanager" class="tsd-anchor"></a>
<h3>connection<wbr>Manager</h3>
<div class="tsd-signature tsd-kind-icon">connection<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="_connection_manager_index_.connectionmanager.html" class="tsd-signature-type">ConnectionManager</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="contentrouting" class="tsd-anchor"></a>
<h3>content<wbr>Routing</h3>
<div class="tsd-signature tsd-kind-icon">content<wbr>Routing<span class="tsd-signature-symbol">:</span> <a href="_content_routing_.contentrouting.html" class="tsd-signature-type">ContentRouting</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="datastore" class="tsd-anchor"></a>
<h3>datastore</h3>
<div class="tsd-signature tsd-kind-icon">datastore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="dialer" class="tsd-anchor"></a>
<h3>dialer</h3>
<div class="tsd-signature tsd-kind-icon">dialer<span class="tsd-signature-symbol">:</span> <a href="../modules/_dialer_dial_request_.html#dialer-1" class="tsd-signature-type">Dialer</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="identifyservice" class="tsd-anchor"></a>
<h3>identify<wbr>Service</h3>
<div class="tsd-signature tsd-kind-icon">identify<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="_identify_index_.identifyservice.html" class="tsd-signature-type">IdentifyService</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="keychain" class="tsd-anchor"></a>
<h3>keychain</h3>
<div class="tsd-signature tsd-kind-icon">keychain<span class="tsd-signature-symbol">:</span> <a href="_keychain_index_.keychain.html" class="tsd-signature-type">Keychain</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="metrics" class="tsd-anchor"></a>
<h3>metrics</h3>
<div class="tsd-signature tsd-kind-icon">metrics<span class="tsd-signature-symbol">:</span> <a href="_metrics_index_.metrics.html" class="tsd-signature-type">Metrics</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="peerid" class="tsd-anchor"></a>
<h3>peer<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="peerrouting" class="tsd-anchor"></a>
<h3>peer<wbr>Routing</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Routing<span class="tsd-signature-symbol">:</span> <a href="_peer_routing_.peerrouting.html" class="tsd-signature-type">PeerRouting</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="peerstore" class="tsd-anchor"></a>
<h3>peer<wbr>Store</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Store<span class="tsd-signature-symbol">:</span> <a href="../modules/_peer_store_book_.html#peerstore" class="tsd-signature-type">PeerStore</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="pubsub-1" 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">PubsubBaseProtocol</span></div>
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="registrar" class="tsd-anchor"></a>
<h3>registrar</h3>
<div class="tsd-signature tsd-kind-icon">registrar<span class="tsd-signature-symbol">:</span> <a href="_registrar_.registrar.html" class="tsd-signature-type">Registrar</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="relay" class="tsd-anchor"></a>
<h3>relay</h3>
<div class="tsd-signature tsd-kind-icon">relay<span class="tsd-signature-symbol">:</span> <a href="_circuit_index_.relay.html" class="tsd-signature-type">Relay</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="transportmanager" class="tsd-anchor"></a>
<h3>transport<wbr>Manager</h3>
<div class="tsd-signature tsd-kind-icon">transport<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="_transport_manager_.transportmanager.html" class="tsd-signature-type">TransportManager</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a name="upgrader" class="tsd-anchor"></a>
<h3>upgrader</h3>
<div class="tsd-signature tsd-kind-icon">upgrader<span class="tsd-signature-symbol">:</span> <a href="_upgrader_.upgrader.html" class="tsd-signature-type">Upgrader</a></div>
<aside class="tsd-sources">
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<a name="connections" class="tsd-anchor"></a>
<h3>connections</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> connections<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets a Map of the current connections. The keys are the stringified
<code>PeerId</code> of the peer. The value is an array of Connections to that peer.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<a name="multiaddrs" class="tsd-anchor"></a>
<h3>multiaddrs</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> multiaddrs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get peer advertising multiaddrs by concating the addresses used
by transports to listen with the announce addresses.
Duplicated addresses and noAnnounce addresses are filtered out.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="_onstarting" class="tsd-anchor"></a>
<h3>_on<wbr>Starting</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">_on<wbr>Starting<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="addlistener" class="tsd-anchor"></a>
<h3>add<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">add<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#addlistener">addListener</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="dial" class="tsd-anchor"></a>
<h3>dial</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">dial<span class="tsd-signature-symbol">(</span>peer<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><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-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dials to the provided peer. If successful, the known metadata of the
peer will be added to the nodes <code>peerStore</code></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>peer: <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The peer to dial</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><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-type">undefined</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="dialprotocol" class="tsd-anchor"></a>
<h3>dial<wbr>Protocol</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">dial<wbr>Protocol<span class="tsd-signature-symbol">(</span>peer<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><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-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dials to the provided peer and handshakes with the given protocol.
If successful, the known metadata of the peer will be added to the nodes <code>peerStore</code>,
and the <code>Connection</code> will be returned</p>
</div>
<dl class="tsd-comment-tags">
<dt>async</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>peer: <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The peer to dial</p>
</div>
</li>
<li>
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><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-type">undefined</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#connection" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="emit" class="tsd-anchor"></a>
<h3>emit</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">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">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#emit">emit</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="getmaxlisteners" class="tsd-anchor"></a>
<h3>get<wbr>Max<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">get<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#getmaxlisteners">getMaxListeners</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="handle" class="tsd-anchor"></a>
<h3>handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>Connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>MuxedStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>string<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers the <code>handler</code> for each protocol</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>handler: <span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>Connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>MuxedStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>string<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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>Connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>MuxedStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>string<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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>Connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>MuxedStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>Connection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>Muxed<wbr>Stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="hangup" class="tsd-anchor"></a>
<h3>hang<wbr>Up</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">hang<wbr>Up<span class="tsd-signature-symbol">(</span>peer<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disconnects all connections to the given <code>peer</code></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>peer: <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the peer to close connections to</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="isstarted" class="tsd-anchor"></a>
<h3>is<wbr>Started</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">is<wbr>Started<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="listenercount" class="tsd-anchor"></a>
<h3>listener<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">listener<wbr>Count<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#listenercount">listenerCount</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="listeners" class="tsd-anchor"></a>
<h3>listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#listeners">listeners</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="loadkeychain" class="tsd-anchor"></a>
<h3>load<wbr>Keychain</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">load<wbr>Keychain<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load keychain keys from the datastore.
Imports the private key as &#39;self&#39;, if needed.</p>
</div>
<dl class="tsd-comment-tags">
<dt>async</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="off" class="tsd-anchor"></a>
<h3>off</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#off">off</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="on" class="tsd-anchor"></a>
<h3>on</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#on">on</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="once" class="tsd-anchor"></a>
<h3>once</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#once">once</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="ping" class="tsd-anchor"></a>
<h3>ping</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">ping<span class="tsd-signature-symbol">(</span>peer<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Pings the given peer in order to obtain the operation latency.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>peer: <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_address_manager_index_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The peer to ping</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="rawlisteners" class="tsd-anchor"></a>
<h3>raw<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">raw<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#rawlisteners">rawListeners</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="removealllisteners" class="tsd-anchor"></a>
<h3>remove<wbr>All<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#removealllisteners">removeAllListeners</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="removelistener" class="tsd-anchor"></a>
<h3>remove<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">remove<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#removelistener">removeListener</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
</li>
<li>
<h5>listener: <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">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a name="setmaxlisteners" class="tsd-anchor"></a>
<h3>set<wbr>Max<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
2021-01-18 17:14:51 +01:00
<li class="tsd-signature tsd-kind-icon">set<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
2020-12-10 15:50:24 +01:00
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
2021-01-18 17:14:51 +01:00
<p>Inherited from <a href="../interfaces/_types_.eventemitter.html">EventEmitter</a>.<a href="../interfaces/_types_.eventemitter.html#setmaxlisteners">setMaxListeners</a></p>
2020-12-10 15:50:24 +01:00
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>n: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
2021-01-18 17:14:51 +01:00
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
2020-12-10 15:50:24 +01:00
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Starts the libp2p node and all its subsystems</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Stop the libp2p node by closing its listeners and open connections</p>
</div>
<dl class="tsd-comment-tags">
<dt>async</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a name="unhandle" class="tsd-anchor"></a>
<h3>unhandle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">unhandle<span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Removes the handler for each protocol. The protocol
will no longer be supported on streams.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-not-exported">
<a name="create" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-signature-type">Libp2pOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="__libp2p_.libp2p.html#createoptions" class="tsd-signature-type">CreateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Like <code>new Libp2p(options)</code> except it will create a <code>PeerId</code>
instance if one is not provided in options.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-signature-type">Libp2pOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="__libp2p_.libp2p.html#createoptions" class="tsd-signature-type">CreateOptions</a></h5>
<div class="tsd-comment tsd-typography">
<p>Libp2p configuration options</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/_connection_manager_index_.html#libp2p" class="tsd-signature-type">Libp2p</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current tsd-kind-module">
<a href="../modules/__libp2p_.html">libp2p</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-not-exported">
<a href="__libp2p_.libp2p.html" class="tsd-kind-icon">Libp2p</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#createoptions" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
2021-01-18 17:14:51 +01:00
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#events" class="tsd-kind-icon">Events</a>
</li>
2020-12-10 15:50:24 +01:00
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#libp2pconfig" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#libp2pmodules" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#libp2poptions" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#peerdiscoveryoptions" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#peerstoreoptions" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#pubsub" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#relayoptions" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="__libp2p_.libp2p.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</a>
</li>
2021-01-18 17:14:51 +01:00
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-not-exported">
2020-12-10 15:50:24 +01:00
<a href="__libp2p_.libp2p.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_config" class="tsd-kind-icon">_config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_dht" class="tsd-kind-icon">_dht</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_discovery" class="tsd-kind-icon">_discovery</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_isstarted" class="tsd-kind-icon">_is<wbr>Started</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_maybeconnect" class="tsd-kind-icon">_maybe<wbr>Connect</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_modules" class="tsd-kind-icon">_modules</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_ondidstart" class="tsd-kind-icon">_on<wbr>Did<wbr>Start</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_ondiscoverypeer" class="tsd-kind-icon">_on<wbr>Discovery<wbr>Peer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_options" class="tsd-kind-icon">_options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_setuppeerdiscovery" class="tsd-kind-icon">_setup<wbr>Peer<wbr>Discovery</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_transport" class="tsd-kind-icon">_transport</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#addressmanager" class="tsd-kind-icon">address<wbr>Manager</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#addresses" class="tsd-kind-icon">addresses</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#connectionmanager" class="tsd-kind-icon">connection<wbr>Manager</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#contentrouting" class="tsd-kind-icon">content<wbr>Routing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#datastore" class="tsd-kind-icon">datastore</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#dialer" class="tsd-kind-icon">dialer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#identifyservice" class="tsd-kind-icon">identify<wbr>Service</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#keychain" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#metrics" class="tsd-kind-icon">metrics</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#peerrouting" class="tsd-kind-icon">peer<wbr>Routing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#peerstore" class="tsd-kind-icon">peer<wbr>Store</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#pubsub-1" class="tsd-kind-icon">pubsub</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#registrar" class="tsd-kind-icon">registrar</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#relay" class="tsd-kind-icon">relay</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#transportmanager" class="tsd-kind-icon">transport<wbr>Manager</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#upgrader" class="tsd-kind-icon">upgrader</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#connections" class="tsd-kind-icon">connections</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#multiaddrs" class="tsd-kind-icon">multiaddrs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#_onstarting" class="tsd-kind-icon">_on<wbr>Starting</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#dial" class="tsd-kind-icon">dial</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#dialprotocol" class="tsd-kind-icon">dial<wbr>Protocol</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#emit" class="tsd-kind-icon">emit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#handle" class="tsd-kind-icon">handle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#hangup" class="tsd-kind-icon">hang<wbr>Up</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#isstarted" class="tsd-kind-icon">is<wbr>Started</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#listeners" class="tsd-kind-icon">listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#loadkeychain" class="tsd-kind-icon">load<wbr>Keychain</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#off" class="tsd-kind-icon">off</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#on" class="tsd-kind-icon">on</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#once" class="tsd-kind-icon">once</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#ping" class="tsd-kind-icon">ping</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#stop" class="tsd-kind-icon">stop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#unhandle" class="tsd-kind-icon">unhandle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-not-exported">
<a href="__libp2p_.libp2p.html#create" class="tsd-kind-icon">create</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#connection" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#createoptions" class="tsd-kind-icon">Create<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#crypto" class="tsd-kind-icon">Crypto</a>
</li>
2021-01-18 17:14:51 +01:00
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#events" class="tsd-kind-icon">Events</a>
</li>
2020-12-10 15:50:24 +01:00
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#libp2pconfig" class="tsd-kind-icon">Libp2p<wbr>Config</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#libp2pmodules" class="tsd-kind-icon">Libp2p<wbr>Modules</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#libp2poptions" class="tsd-kind-icon">Libp2p<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#muxerfactory" class="tsd-kind-icon">Muxer<wbr>Factory</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#peerdiscoveryoptions" class="tsd-kind-icon">Peer<wbr>Discovery<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#peerstoreoptions" class="tsd-kind-icon">Peer<wbr>Store<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#pubsub-1" class="tsd-kind-icon">Pubsub</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#relayoptions" class="tsd-kind-icon">Relay<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#transportfactory" class="tsd-kind-icon">Transport<wbr>Factory</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/__libp2p_.html#libp2p_base" class="tsd-kind-icon">Libp2p_<wbr>base</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-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>
<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-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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
2021-01-18 17:14:51 +01:00
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
2020-12-10 15:50:24 +01:00
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</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>