From 3b6df311084964b3381b0c622debdb0e244a87f4 Mon Sep 17 00:00:00 2001 From: Marc Huffnagle Date: Fri, 16 Mar 2018 11:04:56 -0400 Subject: [PATCH] Fixed jsdoc for crypto's decrypt function --- packages/ingest/crypto.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/ingest/crypto.js b/packages/ingest/crypto.js index b11cda060a5..fdadb835755 100644 --- a/packages/ingest/crypto.js +++ b/packages/ingest/crypto.js @@ -33,15 +33,15 @@ class S3KeyPairProvider { } /** - * Decrypt the given string using the given private key stored in the internal bucket + * Decrypt the given string using a private key stored in S3 * - * @param {string} str - The string to encrypt - * @param {string} keyId - The name of the public key to use for encryption - * @param {string} bucket - the optional bucket name. if not provided will - * use env variable "internal" - * @param {stack} stack - the optional stack name. if not provided will - * use env variable "stackName" - * @returns {Promise} the encrypted string + * @param {string} str - The string to decrypt + * @param {string} keyId - The name of the public key to use for decryption + * @param {string} bucket - the optional bucket name. Defaults to the value of + * the "internal" environment variable + * @param {string} stack - the optional stack name. Defaults to the value of + * the "stackName" environment variable + * @returns {Promise.} the decrypted string */ static async decrypt(str, keyId = 'private.pem', bucket = null, stack = null) { const pki = forge.pki;