fluencelabs/js-peer-id
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-peer-id synced 2025-04-25 17:12:32 +00:00
Code Issues Projects Releases Wiki Activity

chore: update documentation

Browse Source
This commit is contained in:
Vasco Santos 2020-09-23 19:11:26 +02:00
parent 456b250c58
commit 1f2acbf0de
1 changed files with 76 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
index.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset='utf-8'> <meta charset='utf-8'>
<title>peer-id 0.14.1 | Documentation</title> <title>peer-id 0.14.2 | 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.14.1</code></div> <div class='mb1'><code>0.14.2</code></div>
<input <input
placeholder='Filter' placeholder='Filter'
id='filter-input' id='filter-input'
@ -47,6 +47,16 @@
</li> </li>
<li><a
href='#hasinlinepublickey'
class="">
hasInlinePublicKey
</a>
</li>
</ul> </ul>
</div> </div>
<div class='mt1 h6 quiet'> <div class='mt1 h6 quiet'>
@ -67,7 +77,7 @@
</h3> </h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/ecc1e5be6dc702f8537ceb986116c69f2e800194/src/index.js#L150-L158'> <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/10ead07dd976d83df2c377724009e7d3296a50f3/src/index.js#L150-L158'>
<span>src/index.js</span> <span>src/index.js</span>
</a> </a>
@ -142,7 +152,7 @@
</h3> </h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/ecc1e5be6dc702f8537ceb986116c69f2e800194/src/index.js#L166-L168'> <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/10ead07dd976d83df2c377724009e7d3296a50f3/src/index.js#L166-L168'>
<span>src/index.js</span> <span>src/index.js</span>
</a> </a>
@ -204,6 +214,68 @@
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='hasinlinepublickey'>
hasInlinePublicKey
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-peer-id/blob/10ead07dd976d83df2c377724009e7d3296a50f3/src/index.js#L186-L197'>
<span>src/index.js</span>
</a>
</div>
<p>Check if the PeerId has an inline public key.</p>
<div class='pre p1 fill-light mt0'>hasInlinePublicKey(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></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>