mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-04-24 13:52:19 +00:00
chore: update documentation
This commit is contained in:
parent
a43b036469
commit
7fd93fe868
2661
assets/css/main.css
2661
assets/css/main.css
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/search.js
Normal file
1
assets/js/search.js
Normal file
@ -0,0 +1 @@
|
||||
window.searchData = {"kinds":{},"rows":[],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[],"invertedIndex":[],"pipeline":[]}}
|
File diff suppressed because one or more lines are too long
@ -1,912 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Connection | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_connection_connection_.connection.html">Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Connection</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">
|
||||
<div class="lead">
|
||||
<p>An implementation of the js-libp2p connection.
|
||||
Any libp2p transport should use an upgrader to return this connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Connection</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>References</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_connection_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</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="conectionstat" class="tsd-anchor"></a>
|
||||
<h3>Conection<wbr>Stat</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#conectionstat">ConectionStat</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connectionoptions" class="tsd-anchor"></a>
|
||||
<h3>Connection<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#connectionoptions">ConnectionOptions</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/_connection_connection_.html#muxedstream">MuxedStream</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="status" class="tsd-anchor"></a>
|
||||
<h3>Status</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#status">Status</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="streamdata" class="tsd-anchor"></a>
|
||||
<h3>Stream<wbr>Data</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#streamdata">StreamData</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="timeline" class="tsd-anchor"></a>
|
||||
<h3>Timeline</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#timeline-1">Timeline</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Connection<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</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>An implementation of the js-libp2p connection.
|
||||
Any libp2p transport should use an upgrader to return this connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>close<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>get<wbr>Streams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>local<wbr>Addr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>local<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>new<wbr>Stream<span class="tsd-signature-symbol">: </span><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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Addr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_close" class="tsd-anchor"></a>
|
||||
<h3>_close</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_close<span class="tsd-signature-symbol">:</span> <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the close function of the raw connection</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_closing" class="tsd-anchor"></a>
|
||||
<h3>_closing</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_closing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</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">
|
||||
<a name="_getstreams" class="tsd-anchor"></a>
|
||||
<h3>_get<wbr>Streams</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_get<wbr>Streams<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the getStreams function of the muxer</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_newstream" class="tsd-anchor"></a>
|
||||
<h3>_new<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_new<wbr>Stream<span class="tsd-signature-symbol">:</span> <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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the new stream function of the multiplexer</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_stat" class="tsd-anchor"></a>
|
||||
<h3>_stat</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_stat<span class="tsd-signature-symbol">:</span> <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection metadata.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection identifier.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="localaddr" class="tsd-anchor"></a>
|
||||
<h3>local<wbr>Addr</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">local<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Observed multiaddr of the local peer</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="localpeer" class="tsd-anchor"></a>
|
||||
<h3>local<wbr>Peer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">local<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Local peer id.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="registry" class="tsd-anchor"></a>
|
||||
<h3>registry</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">registry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</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">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection streams registry</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="remoteaddr" class="tsd-anchor"></a>
|
||||
<h3>remote<wbr>Addr</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">remote<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Observed multiaddr of the remote peer</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="remotepeer" class="tsd-anchor"></a>
|
||||
<h3>remote<wbr>Peer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">remote<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remote peer id.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="tags" class="tsd-anchor"></a>
|
||||
<h3>tags</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>User provided tags</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="stat" class="tsd-anchor"></a>
|
||||
<h3>stat</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> stat<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</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 connection metadata</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="streams" class="tsd-anchor"></a>
|
||||
<h3>streams</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> streams<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</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 all the streams of the muxer.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="addstream" class="tsd-anchor"></a>
|
||||
<h3>add<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">add<wbr>Stream<span class="tsd-signature-symbol">(</span>muxedStream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>protocol<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-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>Add a stream when it is opened to the registry.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>muxedStream: <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>a muxed stream</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</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">
|
||||
<a name="close" class="tsd-anchor"></a>
|
||||
<h3>close</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">close<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"><</span><span class="tsd-signature-type">void</span><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>Close the connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="newstream" class="tsd-anchor"></a>
|
||||
<h3>new<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new<wbr>Stream<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-type">string</span><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"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><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>Create a new stream from this connection</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-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>intended protocol for the stream</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<blockquote>
|
||||
<p>} with muxed+multistream-selected stream and selected protocol</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="removestream" class="tsd-anchor"></a>
|
||||
<h3>remove<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">remove<wbr>Stream<span class="tsd-signature-symbol">(</span>id<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>Remove stream registry after it is closed.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>identifier of the stream</p>
|
||||
</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">
|
||||
<a name="isconnection" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Connection</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Connection<span class="tsd-signature-symbol">(</span>other<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-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Connection</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>Checks if the given value is a <code>Connection</code> instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Connection</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/_connection_connection_.html">connection/connection</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">
|
||||
<a href="_connection_connection_.connection.html" class="tsd-kind-icon">Connection</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</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/_connection_connection_.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.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/_connection_connection_.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#timeline-1" class="tsd-kind-icon">Timeline</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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</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>
|
@ -1,367 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InvalidCryptoExchangeError | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html">InvalidCryptoExchangeError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class InvalidCryptoExchangeError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">InvalidCryptoExchangeError</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>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Invalid<wbr>Crypto<wbr>Exchange<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-signature-type">InvalidCryptoExchangeError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-signature-type">InvalidCryptoExchangeError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</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/_crypto_errors_.html">crypto/errors</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">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
@ -1,367 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InvalidCryptoTransmissionError | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html">InvalidCryptoTransmissionError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class InvalidCryptoTransmissionError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">InvalidCryptoTransmissionError</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>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Invalid<wbr>Crypto<wbr>Transmission<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-signature-type">InvalidCryptoTransmissionError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-signature-type">InvalidCryptoTransmissionError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</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/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
@ -1,367 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>UnexpectedPeerError | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class UnexpectedPeerError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">UnexpectedPeerError</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>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.unexpectedpeererror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.unexpectedpeererror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.unexpectedpeererror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Unexpected<wbr>Peer<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-signature-type">UnexpectedPeerError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-signature-type">UnexpectedPeerError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</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/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,600 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Topology | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_topology_index_.topology.html">Topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Topology</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>{number} [min=0] - minimum needed connections.</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{number} [max=Infinity] - maximum needed connections.</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{Handlers} [handlers]</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{(peerId: PeerId, conn: Connection) => void} [onConnect] - protocol "onConnect" handler</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{(peerId: PeerId, error?:Error) => void} [onDisconnect] - protocol "onDisconnect" handler</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Topology</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a>
|
||||
</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="_topology_index_.topology.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#options" class="tsd-kind-icon">Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_topology_index_.topology.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_registrar" class="tsd-kind-icon">_registrar</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#max" class="tsd-kind-icon">max</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#min" class="tsd-kind-icon">min</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#peers" class="tsd-kind-icon">peers</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_topology_index_.topology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="_topology_index_.topology.html#registrar" class="tsd-kind-icon">registrar</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_index_.topology.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_topology_index_.topology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</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="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#options">Options</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Topology<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_onconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Connect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><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>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>conn: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_ondisconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Disconnect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">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>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_registrar" class="tsd-anchor"></a>
|
||||
<h3>_registrar</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_registrar<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">
|
||||
<a name="max" class="tsd-anchor"></a>
|
||||
<h3>max</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="min" class="tsd-anchor"></a>
|
||||
<h3>min</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="peers" class="tsd-anchor"></a>
|
||||
<h3>peers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Set of peers that support the protocol.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<a name="registrar" class="tsd-anchor"></a>
|
||||
<h3>registrar</h3>
|
||||
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> registrar<span class="tsd-signature-symbol">(</span>arg<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-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arg: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="disconnect" class="tsd-anchor"></a>
|
||||
<h3>disconnect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><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>Notify about peer disconnected event.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</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">
|
||||
<a name="istopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Topology<span class="tsd-signature-symbol">(</span>other<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-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</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>Checks if the given value is a Topology instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</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/_topology_index_.html">topology/index</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">
|
||||
<a href="_topology_index_.topology.html" class="tsd-kind-icon">Topology</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_registrar" class="tsd-kind-icon">_registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#max" class="tsd-kind-icon">max</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#min" class="tsd-kind-icon">min</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#peers" class="tsd-kind-icon">peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#registrar" class="tsd-kind-icon">registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#disconnect" class="tsd-kind-icon">disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_topology_index_.topology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</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/_topology_index_.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/_topology_index_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</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>
|
@ -1,795 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MulticodecTopology | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html">MulticodecTopology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class MulticodecTopology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MulticodecTopology</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="_topology_multicodec_topology_.multicodectopology.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#connection-1" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#handlers-1" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#options" class="tsd-kind-icon">Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#peerid-1" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_topology_multicodec_topology_.multicodectopology.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_registrar" class="tsd-kind-icon">_registrar</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#max" class="tsd-kind-icon">max</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#min" class="tsd-kind-icon">min</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multicodecs" class="tsd-kind-icon">multicodecs</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#peers" class="tsd-kind-icon">peers</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#registrar" class="tsd-kind-icon">registrar</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_onpeerconnect" class="tsd-kind-icon">_on<wbr>Peer<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_updatepeers" class="tsd-kind-icon">_update<wbr>Peers</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_topology_multicodec_topology_.multicodectopology.html#ismulticodectopology" class="tsd-kind-icon">is<wbr>Multicodec<wbr>Topology</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_topology_multicodec_topology_.multicodectopology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</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="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connection-1" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
Re-exports <a href="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers-1" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</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/_topology_multicodec_topology_.html#multiaddr">Multiaddr</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="multicodecoptions" class="tsd-anchor"></a>
|
||||
<h3>Multicodec<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_multicodec_topology_.html#multicodecoptions">MulticodecOptions</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#options">Options</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid-1" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="topologyoptions" class="tsd-anchor"></a>
|
||||
<h3>Topology<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_multicodec_topology_.html#topologyoptions">TopologyOptions</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Multicodec<wbr>Topology<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>multicodecs<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-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#constructor">constructor</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>multicodecs<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></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_onconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Connect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_onconnect">_onConnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><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>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>conn: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_ondisconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Disconnect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_ondisconnect">_onDisconnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">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>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><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">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_registrar" class="tsd-anchor"></a>
|
||||
<h3>_registrar</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_registrar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_registrar">_registrar</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="max" class="tsd-anchor"></a>
|
||||
<h3>max</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#max">max</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="min" class="tsd-anchor"></a>
|
||||
<h3>min</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#min">min</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="multicodecs" class="tsd-anchor"></a>
|
||||
<h3>multicodecs</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">multicodecs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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-inherited">
|
||||
<a name="peers" class="tsd-anchor"></a>
|
||||
<h3>peers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#peers">peers</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Set of peers that support the protocol.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_symbol_tostringtag_">[Symbol.toStringTag]</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="registrar" class="tsd-anchor"></a>
|
||||
<h3>registrar</h3>
|
||||
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> registrar<span class="tsd-signature-symbol">(</span>arg<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-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#registrar">registrar</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arg: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="_onpeerconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Peer<wbr>Connect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_on<wbr>Peer<wbr>Connect<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><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>Verify if a new connected peer has a topology multicodec and call _onConnect.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>connection: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</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">
|
||||
<a name="_onprotocolchange" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Protocol<wbr>Change</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_on<wbr>Protocol<wbr>Change<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><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-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>Check if a new peer support the multicodecs for this topology.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><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></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>peer<wbr>Id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</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">
|
||||
<a name="_updatepeers" class="tsd-anchor"></a>
|
||||
<h3>_update<wbr>Peers</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_update<wbr>Peers<span class="tsd-signature-symbol">(</span>peerDataIterable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</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-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">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Update topology.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerDataIterable: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</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-symbol">></span></h5>
|
||||
</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-inherited">
|
||||
<a name="disconnect" class="tsd-anchor"></a>
|
||||
<h3>disconnect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><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">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#disconnect">disconnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Notify about peer disconnected event.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</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">
|
||||
<a name="ismulticodectopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Multicodec<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Multicodec<wbr>Topology<span class="tsd-signature-symbol">(</span>other<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-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">MulticodecTopology</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>Checks if the given value is a <code>MulticodecTopology</code> instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">MulticodecTopology</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<a name="istopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Topology<span class="tsd-signature-symbol">(</span>other<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-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#istopology">isTopology</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the given value is a Topology instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</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/_topology_multicodec_topology_.html">topology/multicodec-topology</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">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-kind-icon">Multicodec<wbr>Topology</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#connection-1" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#handlers-1" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peerid-1" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_registrar" class="tsd-kind-icon">_registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#max" class="tsd-kind-icon">max</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#min" class="tsd-kind-icon">min</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multicodecs" class="tsd-kind-icon">multicodecs</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peers" class="tsd-kind-icon">peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#registrar" class="tsd-kind-icon">registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onpeerconnect" class="tsd-kind-icon">_on<wbr>Peer<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_updatepeers" class="tsd-kind-icon">_update<wbr>Peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#disconnect" class="tsd-kind-icon">disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#ismulticodectopology" class="tsd-kind-icon">is<wbr>Multicodec<wbr>Topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</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/_topology_multicodec_topology_.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/_topology_multicodec_topology_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.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/_topology_multicodec_topology_.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#multicodectopology_base" class="tsd-kind-icon">Multicodec<wbr>Topology_<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-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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<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-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>
|
@ -1,357 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>AbortError | libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<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>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
</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/_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_errors_.aborterror.html">AbortError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class AbortError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">AbortError</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>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_transport_errors_.aborterror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_transport_errors_.aborterror.html#type" class="tsd-kind-icon">type</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#type-1" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="type-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> type</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">string</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/_transport_errors_.html">transport/errors</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">
|
||||
<a href="_transport_errors_.aborterror.html" class="tsd-kind-icon">Abort<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_transport_errors_.aborterror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_transport_errors_.aborterror.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#type-1" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</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-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
BIN
globals.html
BIN
globals.html
Binary file not shown.
304
index.html
304
index.html
@ -3,120 +3,11 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>libp2p-interfaces - v0.8.4</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.4">
|
||||
<title>libp2p-interfaces - v0.9.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.9.0">
|
||||
<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>
|
||||
<script async src="assets/js/search.js" id="search-script"></script>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
@ -125,26 +16,41 @@
|
||||
<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>
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="index.html" class="title">libp2p-interfaces - v0.8.4</a>
|
||||
<a href="index.html" class="title">libp2p-interfaces - v0.9.0</a>
|
||||
</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 id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
</ul>
|
||||
<h1>libp2p-interfaces - v0.8.4</h1>
|
||||
<h1>libp2p-interfaces - v0.9.0</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
@ -211,152 +117,8 @@
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/__libp2p_interfaces_.html"> |