diff options
Diffstat (limited to 'docs/global.html')
-rw-r--r-- | docs/global.html | 62 |
1 files changed, 33 insertions, 29 deletions
diff --git a/docs/global.html b/docs/global.html index 20cad1b6..f6015a8e 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@ <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-5/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/encoding/armor.js#L362">line 362</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/encoding/armor.js#L362">line 362</a> </li></ul></dd> @@ -565,7 +565,7 @@ <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-5/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/cleartext.js#L208">line 208</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/cleartext.js#L208">line 208</a> </li></ul></dd> @@ -704,7 +704,7 @@ <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-5/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/key.js#L693">line 693</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/key.js#L693">line 693</a> </li></ul></dd> @@ -1113,7 +1113,7 @@ <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-5/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/message.js#L837">line 837</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/message.js#L837">line 837</a> </li></ul></dd> @@ -1694,7 +1694,7 @@ One of <code>decryptionKeys</code>, <code>sessionkeys</code> or <code>passwords< <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L327">line 327</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L332">line 332</a> </li></ul></dd> @@ -1735,7 +1735,9 @@ One of <code>decryptionKeys</code>, <code>sessionkeys</code> or <code>passwords< signature: Promise<Signature> }, ... ] -}</code></pre> +} + +where `signatures` contains a separate entry for each signature packet found in the input message.</code></pre> </div> @@ -1994,7 +1996,7 @@ This method does not change the original key.</p> <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L168">line 168</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L171">line 171</a> </li></ul></dd> @@ -2353,7 +2355,7 @@ One of <code>decryptionKeys</code> or <code>passwords</code> must be specified.< <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L573">line 573</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L580">line 580</a> </li></ul></dd> @@ -3115,7 +3117,7 @@ must be specified. If signing keys are specified, those will be used to sign the <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L260">line 260</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L263">line 263</a> </li></ul></dd> @@ -3403,7 +3405,7 @@ This method does not change the original key.</p> <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L202">line 202</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L205">line 205</a> </li></ul></dd> @@ -4023,7 +4025,7 @@ At least one of <code>encryptionKeys</code> or <code>passwords</code> must be sp <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L543">line 543</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L550">line 550</a> </li></ul></dd> @@ -4239,7 +4241,7 @@ At least one of <code>encryptionKeys</code> or <code>passwords</code> must be sp <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L705">line 705</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L712">line 712</a> </li></ul></dd> @@ -4832,7 +4834,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L55">line 55</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L56">line 56</a> </li></ul></dd> @@ -5180,7 +5182,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L510">line 510</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L517">line 517</a> </li></ul></dd> @@ -5364,7 +5366,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/packet/packetlist.js#L12">line 12</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/packet/packetlist.js#L12">line 12</a> </li></ul></dd> @@ -5649,7 +5651,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/cleartext.js#L135">line 135</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/cleartext.js#L135">line 135</a> </li></ul></dd> @@ -5937,7 +5939,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/factory.js#L278">line 278</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js#L278">line 278</a> </li></ul></dd> @@ -6225,7 +6227,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/factory.js#L352">line 352</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js#L352">line 352</a> </li></ul></dd> @@ -6519,7 +6521,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/message.js#L793">line 793</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/message.js#L793">line 793</a> </li></ul></dd> @@ -6807,7 +6809,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/factory.js#L315">line 315</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js#L315">line 315</a> </li></ul></dd> @@ -7095,7 +7097,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/factory.js#L397">line 397</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js#L397">line 397</a> </li></ul></dd> @@ -7383,7 +7385,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/signature.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/signature.js#L74">line 74</a> </li></ul></dd> @@ -7844,7 +7846,7 @@ default to main key options, except for <code>sign</code> parameter that default <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L96">line 96</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L99">line 99</a> </li></ul></dd> @@ -8373,7 +8375,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L137">line 137</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L140">line 140</a> </li></ul></dd> @@ -8886,7 +8888,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L389">line 389</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L394">line 394</a> </li></ul></dd> @@ -9048,7 +9050,7 @@ the encoded bytes</p> <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-5/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/encoding/armor.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/encoding/armor.js#L231">line 231</a> </li></ul></dd> @@ -9510,7 +9512,7 @@ an attribute "data" containing a stream of bytes and "type" <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-5/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/openpgp.js#L456">line 456</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/openpgp.js#L463">line 463</a> </li></ul></dd> @@ -9550,7 +9552,9 @@ an attribute "data" containing a stream of bytes and "type" signature: Promise<Signature> }, ... ] -}</code></pre> +} + +where `signatures` contains a separate entry for each signature packet found in the input message.</code></pre> </div> @@ -9752,7 +9756,7 @@ The new key includes a revocation certificate that must be removed before return <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-5/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-5/src/key/factory.js#L156">line 156</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-6/src/key/factory.js#L156">line 156</a> </li></ul></dd> |