Comments & code style

This commit is contained in:
Daniel Huigens
2018-07-05 13:44:33 +02:00
parent 1101a05b10
commit ca537e439d
21 changed files with 354 additions and 171 deletions

View File

@@ -248,7 +248,7 @@ Key.prototype.toPublic = function() {
/**
* Returns ASCII armored text of key
* @returns {String} ASCII armor
* @returns {ReadableStream<String>} ASCII armor
*/
Key.prototype.armor = function() {
const type = this.isPublic() ? enums.armor.public_key : enums.armor.private_key;
@@ -1207,9 +1207,10 @@ export async function read(data) {
/**
* Reads an OpenPGP armored text and returns one or multiple key objects
* @param {String} armoredText text to be parsed
* @param {String | ReadableStream<String>} armoredText text to be parsed
* @returns {{keys: Array<module:key.Key>,
* err: (Array<Error>|null)}} result object with key and error arrays
* @async
* @static
*/
export async function readArmored(armoredText) {