aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan <danjm.com@gmail.com>2018-04-17 11:24:16 +0800
committerDan <danjm.com@gmail.com>2018-04-17 11:24:16 +0800
commit128cb1af46224da9c0f5158107b6ac2da40b0622 (patch)
tree3d1f9f455e01f8bd1893d84fa8bb77a750dfdbc6
parente9ca7199ab9b63ef728fa93f8e98295c3096c553 (diff)
downloadtangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar.gz
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar.bz2
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar.lz
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar.xz
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.tar.zst
tangerine-wallet-browser-128cb1af46224da9c0f5158107b6ac2da40b0622.zip
Improve documentation of promises that return undefined.
-rw-r--r--app/scripts/controllers/address-book.js2
-rw-r--r--app/scripts/controllers/preferences.js6
2 files changed, 4 insertions, 4 deletions
diff --git a/app/scripts/controllers/address-book.js b/app/scripts/controllers/address-book.js
index 222910767..c91e6b2e4 100644
--- a/app/scripts/controllers/address-book.js
+++ b/app/scripts/controllers/address-book.js
@@ -37,7 +37,7 @@ class AddressBookController {
*
* @param {string} address A hex address of a new account that the user is sending to.
* @param {string} name The name the user wishes to associate with the new account
- * @returns {Promise<undefined>} Promises an undefined
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
setAddressBook (address, name) {
diff --git a/app/scripts/controllers/preferences.js b/app/scripts/controllers/preferences.js
index cf0ca13a8..653e6d762 100644
--- a/app/scripts/controllers/preferences.js
+++ b/app/scripts/controllers/preferences.js
@@ -66,7 +66,7 @@ class PreferencesController {
* Setter for the `selectedAddress` property
*
* @param {string} _address A new hex address for an account
- * @returns {Promise<undefined>} Promises an undefined return value
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
setSelectedAddress (_address) {
@@ -159,7 +159,7 @@ class PreferencesController {
* Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list.
*
* @param {string} _url The the new rpc url to add to the updated list
- * @returns {Promise<undefined>} Promises an undefined value.
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
updateFrequentRpcList (_url) {
@@ -174,7 +174,7 @@ class PreferencesController {
* Setter for the `currentAccountTab` property
*
* @param {string} currentAccountTab Specifies the new tab to be marked as current
- * @returns {Promise<undefined>} Promises an undefined value.
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
setCurrentAccountTab (currentAccountTab) {