mirror of
https://github.com/fluencelabs/js-libp2p-crypto
synced 2025-04-25 07:42:30 +00:00
chore: update documentation
This commit is contained in:
Jacob Heun
parent
8e227b40a3
commit
4f784b295b
63
index.html
63
index.html
@ -2,7 +2,7 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta charset='utf-8'>
|
||||
<title>libp2p-crypto 0.17.1 | Documentation</title>
|
||||
<title>libp2p-crypto 0.16.3 | 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.1</code></div>
|
||||
<div class='mb1'><code>0.16.3</code></div>
|
||||
<input
|
||||
placeholder='Filter'
|
||||
id='filter-input'
|
||||
@ -122,7 +122,7 @@
|
||||
</h3>
|
||||
|
||||
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/b5d94ecae7cf56bfc536cbfd326f968f3488f50b/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/2d647cd98b375b428c57c3e99fada8891b672d56/src/keys/rsa-class.js#L119-L126'>
|
||||
<span>src/keys/rsa-class.js</span>
|
||||
</a>
|
||||
|
||||
@ -134,7 +134,7 @@
|
||||
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(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>></div>
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -146,13 +146,26 @@ 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/Promise">Promise</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>></code>:
|
||||
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
|
||||
|
||||
|
||||
|
||||
@ -185,7 +198,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/b5d94ecae7cf56bfc536cbfd326f968f3488f50b/src/keys/rsa-class.js#L115-L135'>
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/2d647cd98b375b428c57c3e99fada8891b672d56/src/keys/rsa-class.js#L136-L169'>
|
||||
<span>src/keys/rsa-class.js</span>
|
||||
</a>
|
||||
|
||||
@ -194,7 +207,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
|
||||
|
||||
<p>Exports the key into a password protected PEM format</p>
|
||||
|
||||
<div class='pre p1 fill-light mt0'>export(password: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, format: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?): KeyInfo</div>
|
||||
<div class='pre p1 fill-light mt0'>export(format: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?, password: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, callback: function (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>, KeyInfo)): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
|
||||
|
||||
|
||||
|
||||
@ -209,6 +222,15 @@ 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'>format</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?)</code>
|
||||
Defaults to 'pkcs-8'.
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>password</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
|
||||
@ -220,9 +242,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
|
||||
|
||||
<div class='space-bottom0'>
|
||||
<div>
|
||||
<span class='code bold'>format</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?
|
||||
= <code>'pkcs-8'</code>)</code>
|
||||
Defaults to 'pkcs-8'.
|
||||
<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>, KeyInfo))</code>
|
||||
|
||||
</div>
|
||||
|
||||
@ -236,7 +256,7 @@ of the PKCS SubjectPublicKeyInfo.</p>
|
||||
|
||||
|
||||
<div class='py1 quiet mt1 prose-big'>Returns</div>
|
||||
<code>KeyInfo</code>:
|
||||
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
|
||||
|
||||
|
||||
|
||||
@ -269,7 +289,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/b5d94ecae7cf56bfc536cbfd326f968f3488f50b/src/keys/ed25519-class.js#L84-L87'>
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/2d647cd98b375b428c57c3e99fada8891b672d56/src/keys/ed25519-class.js#L92-L99'>
|
||||
<span>src/keys/ed25519-class.js</span>
|
||||
</a>
|
||||
|
||||
@ -281,7 +301,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(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>></div>
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -293,13 +313,26 @@ 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/Promise">Promise</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>></code>:
|
||||
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
|
||||
|
||||
|
||||
|
||||
@ -332,7 +365,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/b5d94ecae7cf56bfc536cbfd326f968f3488f50b/src/pbkdf2.js#L14-L18'>
|
||||
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/libp2p/js-libp2p-crypto/blob/2d647cd98b375b428c57c3e99fada8891b672d56/src/pbkdf2.js#L13-L17'>
|
||||
<span>src/pbkdf2.js</span>
|
||||
</a>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user