Docs: clarify content of returned signatures value in openpgp.verify and decrypt

This commit is contained in:
larabr
2021-08-19 17:58:52 +02:00
committed by GitHub
parent 3fa778abe2
commit a599638ce2
2 changed files with 5 additions and 1 deletions

View File

@@ -768,7 +768,7 @@ async function createVerificationObject(signature, literalDataList, verification
* keyID: module:type/keyid~KeyID,
* signature: Promise<Signature>,
* verified: Promise<true>
* }>>} list of signer's keyID and validity of signatures
* }>>} list of signer's keyID and validity of signatures (one entry per signature packet in input)
* @async
* @private
*/

View File

@@ -324,6 +324,8 @@ export async function encrypt({ message, encryptionKeys, signingKeys, passwords,
* }, ...
* ]
* }
*
* where `signatures` contains a separate entry for each signature packet found in the input message.
* @async
* @static
*/
@@ -453,6 +455,8 @@ export async function sign({ message, signingKeys, format = 'armored', detached
* }, ...
* ]
* }
*
* where `signatures` contains a separate entry for each signature packet found in the input message.
* @async
* @static
*/