chore: update documentation

This commit is contained in:
Jacob Heun 2020-07-20 15:24:00 +02:00
parent d2024df808
commit da5150d5fe
No known key found for this signature in database
GPG Key ID: CA5A94C15809879F
3 changed files with 25 additions and 38 deletions

View File

@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>libp2p-crypto 0.17.7 | Documentation</title>
<title>libp2p-crypto 0.17.8 | Documentation</title>
<meta name='description' content='Crypto primitives for libp2p'>
<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-crypto</h3>
<div class='mb1'><code>0.17.7</code></div>
<div class='mb1'><code>0.17.8</code></div>
<input
placeholder='Filter'
id='filter-input'
@ -145,7 +145,7 @@
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/keys/rsa-class.js#L103-L106'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/keys/rsa-class.js#L103-L106'>
<span>src/keys/rsa-class.js</span>
</a>
@ -210,7 +210,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/keys/rsa-class.js#L114-L134'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/keys/rsa-class.js#L114-L134'>
<span>src/keys/rsa-class.js</span>
</a>
@ -288,7 +288,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/keys/rsa.js#L10-L10'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/keys/rsa.js#L10-L10'>
<span>src/keys/rsa.js</span>
</a>
@ -346,7 +346,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/keys/ed25519-class.js#L85-L88'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/keys/ed25519-class.js#L85-L88'>
<span>src/keys/ed25519-class.js</span>
</a>
@ -411,7 +411,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/keys/secp256k1-class.js#L84-L87'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/keys/secp256k1-class.js#L83-L86'>
<span>src/keys/secp256k1-class.js</span>
</a>
@ -423,7 +423,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
The public key is a protobuf encoding containing a type and the DER encoding
of the PKCS SubjectPublicKeyInfo.</p>
<div class='pre p1 fill-light mt0'>id(callback: function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>, id)): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<div class='pre p1 fill-light mt0'>id(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>></div>
@ -435,26 +435,13 @@ of the PKCS SubjectPublicKeyInfo.</p>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>, id))</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/undefined">undefined</a></code>:
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>></code>:
@ -489,7 +476,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
</h3>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/4aa77a6b121100d15bd85c700e2783df3164ef44/src/pbkdf2.js#L30-L43'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/609297be65ceaf98b9cfb295bc9334276dccd659/src/pbkdf2.js#L30-L43'>
<span>src/pbkdf2.js</span>
</a>