1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00

Improve documentation of promises that return undefined.

This commit is contained in:
Dan 2018-04-17 00:54:16 -02:30
parent e9ca7199ab
commit 128cb1af46
2 changed files with 4 additions and 4 deletions

View File

@ -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) {

View File

@ -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) {