<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Module: enums</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">Module: enums</h1>
<section>
<header> </header>
<article> <div class="container-overview">
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".aead"><span class="type-signature">(static, readonly) </span>aead<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-04#section-9.6">RFC4880bis-04, section 9.6</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>eax</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>ocb</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>experimentalGCM</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L180">line 180</a> </li></ul></dd>
</dl>
<h4 class="name" id=".armor"><span class="type-signature">(static, readonly) </span>armor<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Armor type</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>multipartSection</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>multipartLast</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signed</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>message</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>publicKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>privateKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signature</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L409">line 409</a> </li></ul></dd>
</dl>
<h4 class="name" id=".compression"><span class="type-signature">(static, readonly) </span>compression<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/rfc4880#section-9.3">RFC4880, section 9.3</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>uncompressed</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>zip</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>RFC1951</p></td> </tr>
<tr> <td class="name"><code>zlib</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>RFC1950</p></td> </tr>
<tr> <td class="name"><code>bzip2</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L142">line 142</a> </li></ul></dd>
</dl>
<h4 class="name" id=".curve"><span class="type-signature">(static, readonly) </span>curve<span class="type-signature"> :String</span></h4>
<div class="description"> <p>Maps curve names under various standards to one</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">String</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>p256</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>NIST P-256 Curve</p></td> </tr>
<tr> <td class="name"><code>"P-256"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secp256r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>prime256v1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"1.2.840.10045.3.1.7"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2a8648ce3d030107</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2A8648CE3D030107</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>p384</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>NIST P-384 Curve</p></td> </tr>
<tr> <td class="name"><code>"P-384"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secp384r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"1.3.132.0.34"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b81040022</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B81040022</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>p521</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>NIST P-521 Curve</p></td> </tr>
<tr> <td class="name"><code>"P-521"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secp521r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"1.3.132.0.35"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b81040023</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B81040023</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secp256k1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>SECG SECP256k1 Curve</p></td> </tr>
<tr> <td class="name"><code>"1.3.132.0.10"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b8104000a</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B8104000A</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>ED25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>Ed25519</p></td> </tr>
<tr> <td class="name"><code>ed25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>Ed25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"1.3.6.1.4.1.11591.15.1"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b06010401da470f01</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B06010401DA470F01</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>X25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>Curve25519</p></td> </tr>
<tr> <td class="name"><code>cv25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>curve25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>Curve25519</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"1.3.6.1.4.1.3029.1.5.1"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b060104019755010501</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B060104019755010501</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>brainpoolP256r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>BrainpoolP256r1 Curve</p></td> </tr>
<tr> <td class="name"><code>"1.3.36.3.3.2.8.1.1.7"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b2403030208010107</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B2403030208010107</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>brainpoolP384r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>BrainpoolP384r1 Curve</p></td> </tr>
<tr> <td class="name"><code>"1.3.36.3.3.2.8.1.1.11"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b240303020801010b</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B240303020801010B</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>brainpoolP512r1</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>BrainpoolP512r1 Curve</p></td> </tr>
<tr> <td class="name"><code>"1.3.36.3.3.2.8.1.1.13"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2b240303020801010d</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>2B240303020801010D</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L14">line 14</a> </li></ul></dd>
<dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://wiki.gnupg.org/ECC">ECC - GnuPG wiki</a></li> </ul> </dd>
</dl>
<h4 class="name" id=".features"><span class="type-signature">(static, readonly) </span>features<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-04#section-5.2.3.25">RFC4880bis-04, section 5.2.3.25</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>modificationDetection</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x01 - Modification Detection (packets 18 and 19)</p></td> </tr>
<tr> <td class="name"><code>aead</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x02 - AEAD Encrypted Data Packet (packet 20) and version 5Symmetric-Key Encrypted Session Key Packets (packet 3)</p></td> </tr>
<tr> <td class="name"><code>v5Keys</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x04 - Version 5 Public-Key Packet format and corresponding newfingerprint format</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L440">line 440</a> </li></ul></dd>
</dl>
<h4 class="name" id=".hash"><span class="type-signature">(static, readonly) </span>hash<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/rfc4880#section-9.4">RFC4880, section 9.4</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>md5</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>sha1</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>ripemd</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>sha256</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>sha384</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>sha512</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>sha224</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L155">line 155</a> </li></ul></dd>
</dl>
<h4 class="name" id=".keyFlags"><span class="type-signature">(static, readonly) </span>keyFlags<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Key flags</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>certifyKeys</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x01 - This key may be used to certify other keys.</p></td> </tr>
<tr> <td class="name"><code>signData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x02 - This key may be used to sign data.</p></td> </tr>
<tr> <td class="name"><code>encryptCommunication</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x04 - This key may be used to encrypt communications.</p></td> </tr>
<tr> <td class="name"><code>encryptStorage</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x08 - This key may be used to encrypt storage.</p></td> </tr>
<tr> <td class="name"><code>splitPrivateKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x10 - The private component of this key may have been splitby a secret-sharing mechanism.</p></td> </tr>
<tr> <td class="name"><code>authentication</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x20 - This key may be used for authentication.</p></td> </tr>
<tr> <td class="name"><code>sharedPrivateKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x80 - The private component of this key may be in thepossession of more than one person.</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L386">line 386</a> </li></ul></dd>
</dl>
<h4 class="name" id=".literal"><span class="type-signature">(static, readonly) </span>literal<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Data types in the literal packet</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>binary</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Binary data 'b'</p></td> </tr>
<tr> <td class="name"><code>text</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Text data 't'</p></td> </tr>
<tr> <td class="name"><code>utf8</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Utf8 data 'u'</p></td> </tr>
<tr> <td class="name"><code>mime</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>MIME message body part 'm'</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L215">line 215</a> </li></ul></dd>
</dl>
<h4 class="name" id=".packet"><span class="type-signature">(static, readonly) </span>packet<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>A list of packet types and numeric tags associated with them.</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>publicKeyEncryptedSessionKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signature</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>symEncryptedSessionKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>onePassSignature</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secretKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>publicKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>secretSubkey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>compressedData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>symmetricallyEncryptedData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>marker</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>literalData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>trust</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>userID</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>publicSubkey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>userAttribute</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>symEncryptedIntegrityProtectedData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>modificationDetectionCode</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>aeadEncryptedData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L190">line 190</a> </li></ul></dd>
</dl>
<h4 class="name" id=".publicKey"><span class="type-signature">(static, readonly) </span>publicKey<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-04#section-9.1">RFC4880bis-04, section 9.1</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>rsaEncryptSign</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>RSA (Encrypt or Sign) [HAC]</p></td> </tr>
<tr> <td class="name"><code>rsaEncrypt</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>RSA (Encrypt only) [HAC]</p></td> </tr>
<tr> <td class="name"><code>rsaSign</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>RSA (Sign only) [HAC]</p></td> </tr>
<tr> <td class="name"><code>elgamal</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Elgamal (Encrypt only) [ELGAMAL] [HAC]</p></td> </tr>
<tr> <td class="name"><code>dsa</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>DSA (Sign only) [FIPS186] [HAC]</p></td> </tr>
<tr> <td class="name"><code>ecdh</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>ECDH (Encrypt only) [RFC6637]</p></td> </tr>
<tr> <td class="name"><code>ecdsa</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>ECDSA (Sign only) [RFC6637]</p></td> </tr>
<tr> <td class="name"><code>eddsa</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>EdDSA (Sign only)[<a href="https://tools.ietf.org/html/draft-koch-eddsa-for-openpgp-04">Draft RFC</a>]</p></td> </tr>
<tr> <td class="name"><code>aedh</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Reserved for AEDH</p></td> </tr>
<tr> <td class="name"><code>aedsa</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Reserved for AEDSA</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L97">line 97</a> </li></ul></dd>
</dl>
<h4 class="name" id=".reasonForRevocation"><span class="type-signature">(static, readonly) </span>reasonForRevocation<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/rfc4880#section-5.2.3.23">RFC4880, section 5.2.3.23</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>noReason</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>No reason specified (key revocations or cert revocations)</p></td> </tr>
<tr> <td class="name"><code>keySuperseded</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Key is superseded (key revocations)</p></td> </tr>
<tr> <td class="name"><code>keyCompromised</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Key material has been compromised (key revocations)</p></td> </tr>
<tr> <td class="name"><code>keyRetired</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Key is retired and no longer used (key revocations)</p></td> </tr>
<tr> <td class="name"><code>userIDInvalid</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>User ID information is no longer valid (cert revocations)</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L423">line 423</a> </li></ul></dd>
</dl>
<h4 class="name" id=".s2k"><span class="type-signature">(static, readonly) </span>s2k<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>A string to key specifier type</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>simple</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>salted</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>iterated</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>gnu</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L86">line 86</a> </li></ul></dd>
</dl>
<h4 class="name" id=".signature"><span class="type-signature">(static, readonly) </span>signature<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>One pass signature packet type</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>binary</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x00: Signature of a binary document.</p></td> </tr>
<tr> <td class="name"><code>text</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x01: Signature of a canonical text document.</p><p>Canonicalyzing the document by converting line endings.</p></td> </tr>
<tr> <td class="name"><code>standalone</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x02: Standalone signature.</p><p>This signature is a signature of only its own subpacket contents.It is calculated identically to a signature over a zero-lenghbinary document. Note that it doesn't make sense to have a V3standalone signature.</p></td> </tr>
<tr> <td class="name"><code>certGeneric</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x10: Generic certification of a User ID and Public-Key packet.</p><p>The issuer of this certification does not make any particularassertion as to how well the certifier has checked that the ownerof the key is in fact the person described by the User ID.</p></td> </tr>
<tr> <td class="name"><code>certPersona</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x11: Persona certification of a User ID and Public-Key packet.</p><p>The issuer of this certification has not done any verification ofthe claim that the owner of this key is the User ID specified.</p></td> </tr>
<tr> <td class="name"><code>certCasual</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x12: Casual certification of a User ID and Public-Key packet.</p><p>The issuer of this certification has done some casualverification of the claim of identity.</p></td> </tr>
<tr> <td class="name"><code>certPositive</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x13: Positive certification of a User ID and Public-Key packet.</p><p>The issuer of this certification has done substantialverification of the claim of identity.</p><p>Most OpenPGP implementations make their "key signatures" as 0x10certifications. Some implementations can issue 0x11-0x13certifications, but few differentiate between the types.</p></td> </tr>
<tr> <td class="name"><code>certRevocation</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x30: Certification revocation signature</p><p>This signature revokes an earlier User ID certification signature(signature class 0x10 through 0x13) or direct-key signature(0x1F). It should be issued by the same key that issued therevoked signature or an authorized revocation key. The signatureis computed over the same data as the certificate that itrevokes, and should have a later creation date than thatcertificate.</p></td> </tr>
<tr> <td class="name"><code>subkeyBinding</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x18: Subkey Binding Signature</p><p>This signature is a statement by the top-level signing key thatindicates that it owns the subkey. This signature is calculateddirectly on the primary key and subkey, and not on any User ID orother packets. A signature that binds a signing subkey MUST havean Embedded Signature subpacket in this binding signature thatcontains a 0x19 signature made by the signing subkey on theprimary key and subkey.</p></td> </tr>
<tr> <td class="name"><code>keyBinding</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x19: Primary Key Binding Signature</p><p>This signature is a statement by a signing subkey, indicatingthat it is owned by the primary key and subkey. This signatureis calculated the same way as a 0x18 signature: directly on theprimary key and subkey, and not on any User ID or other packets.</p><p>When a signature is made over a key, the hash data starts with theoctet 0x99, followed by a two-octet length of the key, and then bodyof the key packet. (Note that this is an old-style packet header fora key packet with two-octet length.) A subkey binding signature(type 0x18) or primary key binding signature (type 0x19) then hashesthe subkey using the same format as the main key (also using 0x99 asthe first octet).</p></td> </tr>
<tr> <td class="name"><code>key</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x1F: Signature directly on a key</p><p>This signature is calculated directly on a key. It binds theinformation in the Signature subpackets to the key, and isappropriate to be used for subpackets that provide informationabout the key, such as the Revocation Key subpacket. It is alsoappropriate for statements that non-self certifiers want to makeabout the key itself, rather than the binding between a key and aname.</p></td> </tr>
<tr> <td class="name"><code>keyRevocation</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x20: Key revocation signature</p><p>The signature is calculated directly on the key being revoked. Arevoked key is not to be used. Only revocation signatures by thekey being revoked, or by an authorized revocation key, should beconsidered valid revocation signatures.a</p></td> </tr>
<tr> <td class="name"><code>subkeyRevocation</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x28: Subkey revocation signature</p><p>The signature is calculated directly on the subkey being revoked.A revoked subkey is not to be used. Only revocation signaturesby the top-level signature key that is bound to this subkey, orby an authorized revocation key, should be considered validrevocation signatures.</p><p>Key revocation signatures (types 0x20 and 0x28)hash only the key being revoked.</p></td> </tr>
<tr> <td class="name"><code>timestamp</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x40: Timestamp signature.This signature is only meaningful for the timestamp contained init.</p></td> </tr>
<tr> <td class="name"><code>thirdParty</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>0x50: Third-Party Confirmation signature.</p><p>This signature is a signature over some other OpenPGP Signaturepacket(s). It is analogous to a notary seal on the signed data.A third-party signature SHOULD include Signature Targetsubpacket(s) to give easy identification. Note that we really domean SHOULD. There are plausible uses for this (such as a blindparty that only sees the signature, not the key or sourcedocument) that cannot include a target subpacket.</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L231">line 231</a> </li></ul></dd>
</dl>
<h4 class="name" id=".signatureSubpacket"><span class="type-signature">(static, readonly) </span>signatureSubpacket<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Signature subpacket type</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>signatureCreationTime</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signatureExpirationTime</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>exportableCertification</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>trustSignature</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>regularExpression</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>revocable</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>keyExpirationTime</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>placeholderBackwardsCompatibility</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>preferredSymmetricAlgorithms</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>revocationKey</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>issuer</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>notationData</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>preferredHashAlgorithms</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>preferredCompressionAlgorithms</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>keyServerPreferences</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>preferredKeyServer</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>primaryUserID</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>policyURI</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>keyFlags</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signersUserID</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>reasonForRevocation</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>features</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>signatureTarget</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>embeddedSignature</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>issuerFingerprint</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>preferredAEADAlgorithms</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L353">line 353</a> </li></ul></dd>
</dl>
<h4 class="name" id=".symmetric"><span class="type-signature">(static, readonly) </span>symmetric<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/rfc4880#section-9.2">RFC4880, section 9.2</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>plaintext</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>idea</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Not implemented!</p></td> </tr>
<tr> <td class="name"><code>tripledes</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>cast5</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>blowfish</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>aes128</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>aes192</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>aes256</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>twofish</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L125">line 125</a> </li></ul></dd>
</dl>
<h4 class="name" id=".webHash"><span class="type-signature">(static) </span>webHash<span class="type-signature"> :String</span></h4>
<div class="description"> <p>A list of hash names as accepted by webCrypto functions.<a href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest">Parameters, algo</a></p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">String</span>
</li> </ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>"SHA-1"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"SHA-256"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"SHA-384"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>"SHA-512"</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L169">line 169</a> </li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".read"><span class="type-signature">(static) </span>read<span class="signature">(type, e)</span><span class="type-signature"> → {String}</span></h4>
<div class="description"> <p>Converts enum integer value to the corresponding string, if it exists.</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>type</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="description last"><p>target enum type</p></td> </tr>
<tr> <td class="name"><code>e</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>value to convert</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L477">line 477</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl> <dt> <div class="param-desc"> <p>if the value is invalid</p> </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span>
</dd> </dl> </dt> <dd></dd></dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>name of enum value if it exists</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">String</span>
</dd></dl>
<h4 class="name" id=".write"><span class="type-signature">(static) </span>write<span class="signature">(type, e)</span><span class="type-signature"> → {Integer}</span></h4>
<div class="description"> <p>Asserts validity of given value and converts from string/integer to integer.</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>type</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="description last"><p>target enum type</p></td> </tr>
<tr> <td class="name"><code>e</code></td>
<td class="type"> <span class="param-type">String</span>|
<span class="param-type">Integer</span>
</td>
<td class="description last"><p>value to check and/or convert</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.4.0/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/enums.js#L458">line 458</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl> <dt> <div class="param-desc"> <p>if the value is invalid</p> </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span>
</dd> </dl> </dt> <dd></dd></dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>enum value if it exists</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Integer</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>