Skip to content

Commit

Permalink
5.0.0-2
Browse files Browse the repository at this point in the history
  • Loading branch information
@twiss
twiss committed Apr 27, 2021
1 parent 28c5902 commit 2d07c43
Show file tree
Hide file tree
Showing 34 changed files with 2,075 additions and 3,925 deletions.
102 changes: 11 additions & 91 deletions docs/AEADEncryptedDataPacket.html
View file
Expand Up @@ -98,7 +98,7 @@ <h4 class="name" id="AEADEncryptedDataPacket"><span class="type-signature"></spa

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L40">line 40</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L51">line 51</a>
</li></ul></dd>


Expand Down Expand Up @@ -154,7 +154,7 @@ <h3 class="subsection-title">Methods</h3>



<h4 class="name" id="crypt"><span class="type-signature">(async) </span>crypt<span class="signature">(fn, key, data, streaming)</span><span class="type-signature"> &rarr; {Uint8Array|ReadableStream.&lt;Uint8Array>}</span></h4>
<h4 class="name" id="crypt"><span class="type-signature">(async) </span>crypt<span class="signature">(fn, key, data)</span><span class="type-signature"> &rarr; {Promise.&lt;(Uint8Array|ReadableStream.&lt;Uint8Array>)>}</span></h4>



Expand Down Expand Up @@ -270,29 +270,6 @@ <h5>Parameters:</h5>
</tr>



<tr>

<td class="name"><code>streaming</code></td>


<td class="type">


<span class="param-type">Boolean</span>



</td>





<td class="description last"><p>Whether the top-level function will return a stream</p></td>
</tr>


</tbody>
</table>

Expand Down Expand Up @@ -332,7 +309,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L123">line 123</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L125">line 125</a>
</li></ul></dd>


Expand Down Expand Up @@ -368,10 +345,7 @@ <h5>Returns:</h5>
</dt>
<dd>

<span class="param-type">Uint8Array</span>
|

<span class="param-type">ReadableStream.&lt;Uint8Array></span>
<span class="param-type">Promise.&lt;(Uint8Array|ReadableStream.&lt;Uint8Array>)></span>


</dd>
Expand All @@ -389,7 +363,7 @@ <h5>Returns:</h5>



<h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key, streaming)</span><span class="type-signature"></span></h4>
<h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key)</span><span class="type-signature"></span></h4>



Expand Down Expand Up @@ -476,29 +450,6 @@ <h5>Parameters:</h5>
</tr>



<tr>

<td class="name"><code>streaming</code></td>


<td class="type">


<span class="param-type">Boolean</span>



</td>





<td class="description last"><p>Whether the top-level function will return a stream</p></td>
</tr>


</tbody>
</table>

Expand Down Expand Up @@ -538,7 +489,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L86">line 86</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L95">line 95</a>
</li></ul></dd>


Expand Down Expand Up @@ -603,7 +554,7 @@ <h5>Throws:</h5>



<h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, streaming, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>



Expand Down Expand Up @@ -709,37 +660,6 @@ <h5>Parameters:</h5>



<tr>

<td class="name"><code>streaming</code></td>


<td class="type">


<span class="param-type">Boolean</span>



</td>


<td class="attributes">





</td>




<td class="description last"><p>Whether the top-level function will return a stream</p></td>
</tr>



<tr>

<td class="name"><code>config</code></td>
Expand Down Expand Up @@ -811,7 +731,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L104">line 104</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L107">line 107</a>
</li></ul></dd>


Expand Down Expand Up @@ -982,7 +902,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L56">line 56</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L66">line 66</a>
</li></ul></dd>


Expand Down Expand Up @@ -1072,7 +992,7 @@ <h4 class="name" id="write"><span class="type-signature"></span>write<span class

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L74">line 74</a>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L84">line 84</a>
</li></ul></dd>


Expand Down Expand Up @@ -1143,7 +1063,7 @@ <h5>Returns:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#armor">armor</a></li><li><a href="global.html#decrypt">decrypt</a></li><li><a href="global.html#decryptKey">decryptKey</a></li><li><a href="global.html#decryptSessionKeys">decryptSessionKeys</a></li><li><a href="global.html#encrypt">encrypt</a></li><li><a href="global.html#encryptKey">encryptKey</a></li><li><a href="global.html#encryptSessionKey">encryptSessionKey</a></li><li><a href="global.html#generateKey">generateKey</a></li><li><a href="global.html#generateSessionKey">generateSessionKey</a></li><li><a href="global.html#readCleartextMessage">readCleartextMessage</a></li><li><a href="global.html#readKey">readKey</a></li><li><a href="global.html#readKeys">readKeys</a></li><li><a href="global.html#readMessage">readMessage</a></li><li><a href="global.html#readSignature">readSignature</a></li><li><a href="global.html#reformatKey">reformatKey</a></li><li><a href="global.html#revokeKey">revokeKey</a></li><li><a href="global.html#sign">sign</a></li><li><a href="global.html#unarmor">unarmor</a></li><li><a href="global.html#verify">verify</a></li></ul><h3>Modules</h3><ul><li><a href="module-config.html">config</a></li><li><a href="module-enums.html">enums</a></li></ul><h3>Classes</h3><ul><li><a href="AEADEncryptedDataPacket.html">AEADEncryptedDataPacket</a></li><li><a href="CleartextMessage.html">CleartextMessage</a></li><li><a href="CompressedDataPacket.html">CompressedDataPacket</a></li><li><a href="Key.html">Key</a></li><li><a href="LiteralDataPacket.html">LiteralDataPacket</a></li><li><a href="MarkerPacket.html">MarkerPacket</a></li><li><a href="Message.html">Message</a></li><li><a href="module-crypto_random-RandomBuffer.html">RandomBuffer</a></li><li><a href="module-key_SubKey-SubKey.html">SubKey</a></li><li><a href="module-key_User-User.html">User</a></li><li><a href="module-type_kdf_params-KDFParams.html">KDFParams</a></li><li><a href="module-type_keyid-Keyid.html">Keyid</a></li><li><a href="module-type_s2k-S2K.html">S2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PublicKeyEncryptedSessionKeyPacket.html">PublicKeyEncryptedSessionKeyPacket</a></li><li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li><li><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></li><li><a href="SecretKeyPacket.html">SecretKeyPacket</a></li><li><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></li><li><a href="Signature.html">Signature</a></li><li><a href="SignaturePacket.html">SignaturePacket</a></li><li><a href="SymEncryptedIntegrityProtectedDataPacket.html">SymEncryptedIntegrityProtectedDataPacket</a></li><li><a href="SymEncryptedSessionKeyPacket.html">SymEncryptedSessionKeyPacket</a></li><li><a href="SymmetricallyEncryptedDataPacket.html">SymmetricallyEncryptedDataPacket</a></li><li><a href="TrustPacket.html">TrustPacket</a></li><li><a href="UserAttributePacket.html">UserAttributePacket</a></li><li><a href="UserIDPacket.html">UserIDPacket</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#armor">armor</a></li><li><a href="global.html#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</a></li><li><a href="global.html#decrypt">decrypt</a></li><li><a href="global.html#decryptKey">decryptKey</a></li><li><a href="global.html#decryptSessionKeys">decryptSessionKeys</a></li><li><a href="global.html#encrypt">encrypt</a></li><li><a href="global.html#encryptKey">encryptKey</a></li><li><a href="global.html#encryptSessionKey">encryptSessionKey</a></li><li><a href="global.html#generateKey">generateKey</a></li><li><a href="global.html#generateSessionKey">generateSessionKey</a></li><li><a href="global.html#newPacketFromTag">newPacketFromTag</a></li><li><a href="global.html#readCleartextMessage">readCleartextMessage</a></li><li><a href="global.html#readKey">readKey</a></li><li><a href="global.html#readKeys">readKeys</a></li><li><a href="global.html#readMessage">readMessage</a></li><li><a href="global.html#readSignature">readSignature</a></li><li><a href="global.html#reformatKey">reformatKey</a></li><li><a href="global.html#revokeKey">revokeKey</a></li><li><a href="global.html#sign">sign</a></li><li><a href="global.html#unarmor">unarmor</a></li><li><a href="global.html#verify">verify</a></li></ul><h3>Modules</h3><ul><li><a href="module-config.html">config</a></li><li><a href="module-enums.html">enums</a></li></ul><h3>Classes</h3><ul><li><a href="AEADEncryptedDataPacket.html">AEADEncryptedDataPacket</a></li><li><a href="CleartextMessage.html">CleartextMessage</a></li><li><a href="CompressedDataPacket.html">CompressedDataPacket</a></li><li><a href="Key.html">Key</a></li><li><a href="LiteralDataPacket.html">LiteralDataPacket</a></li><li><a href="MarkerPacket.html">MarkerPacket</a></li><li><a href="Message.html">Message</a></li><li><a href="module-crypto_random-RandomBuffer.html">RandomBuffer</a></li><li><a href="module-key_SubKey-SubKey.html">SubKey</a></li><li><a href="module-key_User-User.html">User</a></li><li><a href="module-type_kdf_params-KDFParams.html">KDFParams</a></li><li><a href="module-type_keyid-KeyID.html">KeyID</a></li><li><a href="module-type_s2k-S2K.html">S2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PublicKeyEncryptedSessionKeyPacket.html">PublicKeyEncryptedSessionKeyPacket</a></li><li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li><li><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></li><li><a href="SecretKeyPacket.html">SecretKeyPacket</a></li><li><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></li><li><a href="Signature.html">Signature</a></li><li><a href="SignaturePacket.html">SignaturePacket</a></li><li><a href="SymEncryptedIntegrityProtectedDataPacket.html">SymEncryptedIntegrityProtectedDataPacket</a></li><li><a href="SymEncryptedSessionKeyPacket.html">SymEncryptedSessionKeyPacket</a></li><li><a href="SymmetricallyEncryptedDataPacket.html">SymmetricallyEncryptedDataPacket</a></li><li><a href="TrustPacket.html">TrustPacket</a></li><li><a href="UserAttributePacket.html">UserAttributePacket</a></li><li><a href="UserIDPacket.html">UserIDPacket</a></li></ul>
</nav>

<br class="clear">
Expand Down

0 comments on commit 2d07c43

Please sign in to comment.