diff options
author | bitpshr <mail@bitpshr.net> | 2018-04-19 09:30:13 +0800 |
---|---|---|
committer | bitpshr <mail@bitpshr.net> | 2018-04-19 09:30:13 +0800 |
commit | 1ef6528921263fb9dbae35476a1d9827e1d87508 (patch) | |
tree | b0a4da9a783e902ec4e984f94d892542868756bb /app/scripts/edge-encryptor.js | |
parent | 6dbdc87713a652dec4c90fa792dda08d613d4198 (diff) | |
download | tangerine-wallet-browser-1ef6528921263fb9dbae35476a1d9827e1d87508.tar.gz tangerine-wallet-browser-1ef6528921263fb9dbae35476a1d9827e1d87508.tar.zst tangerine-wallet-browser-1ef6528921263fb9dbae35476a1d9827e1d87508.zip |
Add JSDoc to various background scripts
Diffstat (limited to 'app/scripts/edge-encryptor.js')
-rw-r--r-- | app/scripts/edge-encryptor.js | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/app/scripts/edge-encryptor.js b/app/scripts/edge-encryptor.js index 5f6699746..d2e985790 100644 --- a/app/scripts/edge-encryptor.js +++ b/app/scripts/edge-encryptor.js @@ -7,11 +7,11 @@ const Unibabel = require('browserify-unibabel') */ class EdgeEncryptor { /** - * Encrypts an arbitrary JavaScript object to cypher text + * Encrypts an arbitrary JavaScript object to ciphertext * - * @param {string} password Password used to unlock a cryptographic key + * @param {string} password Used to generate a key to encrypt the data * @param {Object} dataObject Data to encrypt - * @returns {Object} Object containing cypher text, generation vectors, and salt + * @returns {Promise<Object>} Promise resolving to an object with ciphertext */ encrypt (password, dataObject) { var salt = this._generateSalt() @@ -34,10 +34,10 @@ class EdgeEncryptor { } /** - * Decrypts an arbitrary JavaScript object from cypher text + * Decrypts an arbitrary JavaScript object from ciphertext * - * @param {string} password Password used to unlock a cryptographic key - * @param {string} text Cypher text of an encrypted JavaScript object + * @param {string} password Used to generate a key to decrypt the data + * @param {string} text Ciphertext of an encrypted JavaScript object * @returns {Promise<Object>} Promise resolving to copy of decrypted JavaScript object */ decrypt (password, text) { |