mirror of
https://github.com/fluencelabs/js-libp2p-tcp
synced 2025-04-25 17:22:30 +00:00
chore: update documentation
This commit is contained in:
Jacob Heun
parent
41e7ea6f7f
commit
7c9e77a5db
376
index.html
376
index.html
@ -1,8 +1,8 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset='utf-8'>
|
||||
<title>libp2p-tcp 0.13.2 | Documentation</title>
|
||||
<title>libp2p-tcp 0.14.2 | Documentation</title>
|
||||
<meta name='description' content='Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces'>
|
||||
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
||||
<link href='assets/bass.css' rel='stylesheet'>
|
||||
@ -15,7 +15,7 @@
|
||||
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
||||
<div class='py1 px2'>
|
||||
<h3 class='mb0 no-anchor'>libp2p-tcp</h3>
|
||||
<div class='mb1'><code>0.13.2</code></div>
|
||||
<div class='mb1'><code>0.14.2</code></div>
|
||||
<input
|
||||
placeholder='Filter'
|
||||
id='filter-input'
|
||||
@ -34,6 +34,46 @@
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li><a
|
||||
href='#tcp'
|
||||
class=" toggle-sibling">
|
||||
TCP
|
||||
<span class='icon'>▸</span>
|
||||
</a>
|
||||
|
||||
<div class='toggle-target display-none'>
|
||||
|
||||
|
||||
<ul class='list-reset py1-ul pl1'>
|
||||
<li class='h5'><span>Instance members</span></li>
|
||||
|
||||
<li><a
|
||||
href='#tcpdial'
|
||||
class='regular pre-open'>
|
||||
#dial
|
||||
</a></li>
|
||||
|
||||
<li><a
|
||||
href='#tcpcreatelistener'
|
||||
class='regular pre-open'>
|
||||
#createListener
|
||||
</a></li>
|
||||
|
||||
<li><a
|
||||
href='#tcpfilter'
|
||||
class='regular pre-open'>
|
||||
#filter
|
||||
</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
<div class='mt1 h6 quiet'>
|
||||
@ -71,6 +111,336 @@
|
||||
</section></div>
|
||||
|
||||
|
||||
|
||||
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||
|
||||
|
||||
<div class='clearfix'>
|
||||
|
||||
<h3 class='fl m0' id='tcp'>
|
||||
TCP
|
||||
</h3>
|
||||
|
||||
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/657d3e6f4a7584ffdeb1378486a6eb153af8bf47/src/index.js#L18-L138'>
|
||||
<span>src/index.js</span>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class='pre p1 fill-light mt0'>new TCP()</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
|
||||
<div class="clearfix">
|
||||
|
||||
<div class='border-bottom' id='tcpdial'>
|
||||
<div class="clearfix small pointer toggle-sibling">
|
||||
<div class="py1 contain">
|
||||
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
||||
<span class='code strong strong truncate'>dial(ma, options)</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearfix display-none toggle-target">
|
||||
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||
|
||||
|
||||
<div class='clearfix'>
|
||||
|
||||
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/657d3e6f4a7584ffdeb1378486a6eb153af8bf47/src/index.js#L36-L44'>
|
||||
<span>src/index.js</span>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class='pre p1 fill-light mt0'>dial(ma: Multiaddr, options: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>): Connection</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
||||
<div class='prose'>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>ma</span> <code class='quiet'>(Multiaddr)</code>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>options</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
|
||||
|
||||
</div>
|
||||
|
||||
<table class='mt1 mb2 fixed-table h5 col-12'>
|
||||
<colgroup>
|
||||
<col width='30%' />
|
||||
<col width='70%' />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class='bold fill-light'>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody class='mt1'>
|
||||
|
||||
<tr>
|
||||
<td class='break-word'><span class='code bold'>options.signal</span> <code class='quiet'>AbortSignal</code>
|
||||
</td>
|
||||
<td class='break-word'><span>Used to abort dial requests
|
||||
</span></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
||||
<code>Connection</code>:
|
||||
An upgraded Connection
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class='border-bottom' id='tcpcreatelistener'>
|
||||
<div class="clearfix small pointer toggle-sibling">
|
||||
<div class="py1 contain">
|
||||
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
||||
<span class='code strong strong truncate'>createListener(options?, handler)</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearfix display-none toggle-target">
|
||||
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||
|
||||
|
||||
<div class='clearfix'>
|
||||
|
||||
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/657d3e6f4a7584ffdeb1378486a6eb153af8bf47/src/index.js#L113-L120'>
|
||||
<span>src/index.js</span>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<p>Creates a TCP listener. The provided <code>handler</code> function will be called
|
||||
anytime a new incoming Connection has been successfully upgraded via
|
||||
<code>upgrader.upgradeInbound</code>.</p>
|
||||
|
||||
<div class='pre p1 fill-light mt0'>createListener(options: any?, handler: function (Connection)): Listener</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
||||
<div class='prose'>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>options</span> <code class='quiet'>(any?)</code>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>handler</span> <code class='quiet'>(function (Connection))</code>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
||||
<code>Listener</code>:
|
||||
A TCP listener
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class='border-bottom' id='tcpfilter'>
|
||||
<div class="clearfix small pointer toggle-sibling">
|
||||
<div class="py1 contain">
|
||||
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
|
||||
<span class='code strong strong truncate'>filter(multiaddrs)</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearfix display-none toggle-target">
|
||||
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||
|
||||
|
||||
<div class='clearfix'>
|
||||
|
||||
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-tcp/blob/657d3e6f4a7584ffdeb1378486a6eb153af8bf47/src/index.js#L127-L137'>
|
||||
<span>src/index.js</span>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<p>Takes a list of <code>Multiaddr</code>s and returns only valid TCP addresses</p>
|
||||
|
||||
<div class='pre p1 fill-light mt0'>filter(multiaddrs: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><Multiaddr>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><Multiaddr></div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
||||
<div class='prose'>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>multiaddrs</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><Multiaddr>)</code>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
||||
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><Multiaddr></code>:
|
||||
Valid TCP multiaddrs
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<script src='assets/anchor.js'></script>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user