<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Class: PacketList</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"></head>
<body>
<div id="main">
<h1 class="page-title">Class: PacketList</h1>
<section>
<header> <h2><span class="attribs"><span class="type-signature"></span></span>PacketList<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description"><p>This class represents a list of openpgp packets.Take care when iterating over it - the packets themselvesare stored as numerical indices.</p></div> </header>
<article> <div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="PacketList"><span class="type-signature"></span>new PacketList<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L40">line 40</a> </li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul> <li>Array</li> </ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".fromBinary"><span class="type-signature">(async, static) </span>fromBinary<span class="signature">(bytes, allowedPackets, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="PacketList.html">PacketList</a>}</span></h4>
<div class="description"> <p>Parses the given binary data and returns a list of packets.Equivalent to calling <code>read</code> on an empty PacketList instance.</p></div>
<h5>Parameters:</h5>
<table class="params"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>bytes</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.<Uint8Array></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>binary data to parse</p></td> </tr>
<tr> <td class="name"><code>allowedPackets</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>mapping where keys are allowed packet tags, pointing to their Packet class</p></td> </tr>
<tr> <td class="name"><code>config</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="attributes"> <optional><br>
</td>
<td class="description last"><p>full configuration, defaults to openpgp.config</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L51">line 51</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc"> <p>on parsing errors</p> </div>
<h5>Returns:</h5>
<div class="param-desc"> <p>parsed list of packets</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type"><a href="PacketList.html">PacketList</a></span>
</dd></dl>
<h4 class="name" id="filterByTag"><span class="type-signature"></span>filterByTag<span class="signature">(…tags)</span><span class="type-signature"> → {<a href="PacketList.html">PacketList</a>}</span></h4>
<div class="description"> <p>Creates a new PacketList with all packets matching the given tag(s)</p></div>
<h5>Parameters:</h5>
<table class="params"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>tags</code></td>
<td class="type"> <span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span>
</td>
<td class="attributes">
<repeatable><br> </td>
<td class="description last"><p>packet tags to look for</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L171">line 171</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type"><a href="PacketList.html">PacketList</a></span>
</dd></dl>
<h4 class="name" id="findPacket"><span class="type-signature"></span>findPacket<span class="signature">(tag)</span><span class="type-signature"> → {Packet|undefined}</span></h4>
<div class="description"> <p>Traverses packet list and returns first packet with matching tag</p></div>
<h5>Parameters:</h5>
<table class="params"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>tag</code></td>
<td class="type"> <span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span>
</td>
<td class="description last"><p>The packet tag</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L190">line 190</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">Packet</span>|
<span class="param-type">undefined</span>
</dd></dl>
<h4 class="name" id="indexOfTag"><span class="type-signature"></span>indexOfTag<span class="signature">(…tags)</span><span class="type-signature"> → {Array.<Integer>}</span></h4>
<div class="description"> <p>Find indices of packets with the given tag(s)</p></div>
<h5>Parameters:</h5>
<table class="params"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>tags</code></td>
<td class="type"> <span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span>
</td>
<td class="attributes">
<repeatable><br> </td>
<td class="description last"><p>packet tags to look for</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L199">line 199</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>packet indices</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Array.<Integer></span>
</dd></dl>
<h4 class="name" id="read"><span class="type-signature">(async) </span>read<span class="signature">(bytes, allowedPackets, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description"> <p>Reads a stream of binary data and interprets it as a list of packets.</p></div>
<h5>Parameters:</h5>
<table class="params"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>bytes</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.<Uint8Array></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>binary data to parse</p></td> </tr>
<tr> <td class="name"><code>allowedPackets</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>mapping where keys are allowed packet tags, pointing to their Packet class</p></td> </tr>
<tr> <td class="name"><code>config</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="attributes"> <optional><br>
</td>
<td class="description last"><p>full configuration, defaults to openpgp.config</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L65">line 65</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc"> <p>on parsing errors</p> </div>
<h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4>
<div class="description"> <p>Creates a binary representation of openpgp objects contained within theclass instance.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/packetlist.js#L128">line 128</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>A Uint8Array containing valid openpgp packets.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>
</dd></dl>
</article>
</section>
</div>
<nav> <h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#aes">aes</a></li><li><a href="global.html#armor">armor</a></li><li><a href="global.html#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createKey">createKey</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#formatObject">formatObject</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#readPrivateKey">readPrivateKey</a></li><li><a href="global.html#readPrivateKeys">readPrivateKeys</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><li><a href="global.html#wrapKeyObject">wrapKeyObject</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="PrivateKey.html">PrivateKey</a></li><li><a href="PublicKey.html">PublicKey</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">
<footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a></footer>
<script> prettyPrint(); </script><script src="scripts/linenumber.js"> </script></body></html>