mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-06-15 13:51:33 +00:00
chore: update documentation
This commit is contained in:
Vasco Santos
172
index.html
172
index.html
@ -2,7 +2,7 @@
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset='utf-8'>
|
<meta charset='utf-8'>
|
||||||
<title>peer-id 0.13.4 | Documentation</title>
|
<title>peer-id 0.13.5 | Documentation</title>
|
||||||
<meta name='description' content='IPFS Peer Id implementation in Node.js'>
|
<meta name='description' content='IPFS Peer Id implementation in Node.js'>
|
||||||
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
||||||
<link href='assets/bass.css' rel='stylesheet'>
|
<link href='assets/bass.css' rel='stylesheet'>
|
||||||
@ -15,7 +15,7 @@
|
|||||||
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
||||||
<div class='py1 px2'>
|
<div class='py1 px2'>
|
||||||
<h3 class='mb0 no-anchor'>peer-id</h3>
|
<h3 class='mb0 no-anchor'>peer-id</h3>
|
||||||
<div class='mb1'><code>0.13.4</code></div>
|
<div class='mb1'><code>0.13.5</code></div>
|
||||||
<input
|
<input
|
||||||
placeholder='Filter'
|
placeholder='Filter'
|
||||||
id='filter-input'
|
id='filter-input'
|
||||||
@ -34,6 +34,26 @@
|
|||||||
|
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li><a
|
||||||
|
href='#equals'
|
||||||
|
class="">
|
||||||
|
equals
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li><a
|
||||||
|
href='#isequal'
|
||||||
|
class="">
|
||||||
|
isEqual
|
||||||
|
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</li>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div class='mt1 h6 quiet'>
|
<div class='mt1 h6 quiet'>
|
||||||
@ -71,6 +91,154 @@
|
|||||||
</section></div>
|
</section></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='clearfix'>
|
||||||
|
|
||||||
|
<h3 class='fl m0' id='equals'>
|
||||||
|
equals
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
|
||||||
|
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/b5335cd4ee08574040fc5bb5bc61c6d30e0c53b0/src/index.js#L141-L149'>
|
||||||
|
<span>src/index.js</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Checks the equality of <code>this</code> peer against a given PeerId.</p>
|
||||||
|
|
||||||
|
<div class='pre p1 fill-light mt0'>equals(id: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | PeerId)): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
||||||
|
<div class='prose'>
|
||||||
|
|
||||||
|
<div class='space-bottom0'>
|
||||||
|
<div>
|
||||||
|
<span class='code bold'>id</span> <code class='quiet'>((<a href="https://nodejs.org/api/buffer.html">Buffer</a> | PeerId))</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/Boolean">boolean</a></code>:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<section class='p2 mb2 clearfix bg-white minishadow'>
|
||||||
|
|
||||||
|
|
||||||
|
<div class='clearfix'>
|
||||||
|
|
||||||
|
<h3 class='fl m0' id='isequal'>
|
||||||
|
isEqual
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
|
||||||
|
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/b5335cd4ee08574040fc5bb5bc61c6d30e0c53b0/src/index.js#L157-L159'>
|
||||||
|
<span>src/index.js</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Checks the equality of <code>this</code> peer against a given PeerId.</p>
|
||||||
|
|
||||||
|
<div class='pre p1 fill-light mt0'>isEqual(id: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | PeerId)): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div>Deprecated: Use
|
||||||
|
<code>.equals</code>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class='py1 quiet mt1 prose-big'>Parameters</div>
|
||||||
|
<div class='prose'>
|
||||||
|
|
||||||
|
<div class='space-bottom0'>
|
||||||
|
<div>
|
||||||
|
<span class='code bold'>id</span> <code class='quiet'>((<a href="https://nodejs.org/api/buffer.html">Buffer</a> | PeerId))</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/Boolean">boolean</a></code>:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<script src='assets/anchor.js'></script>
|
<script src='assets/anchor.js'></script>
|
||||||
|
|||||||
Reference in New Issue
Block a user