From e9ca7199ab9b63ef728fa93f8e98295c3096c553 Mon Sep 17 00:00:00 2001 From: Dan Date: Mon, 16 Apr 2018 21:23:29 -0230 Subject: [PATCH] Typo fixes, type fixes on the return clauses of the buyEthUrl and getPrefferedLangCode functions. --- app/scripts/controllers/address-book.js | 2 +- app/scripts/controllers/currency.js | 2 +- app/scripts/controllers/preferences.js | 2 +- app/scripts/controllers/shapeshift.js | 2 +- app/scripts/lib/buy-eth-url.js | 5 +++-- app/scripts/lib/nodeify.js | 2 +- 6 files changed, 8 insertions(+), 7 deletions(-) diff --git a/app/scripts/controllers/address-book.js b/app/scripts/controllers/address-book.js index 62205a430..222910767 100644 --- a/app/scripts/controllers/address-book.js +++ b/app/scripts/controllers/address-book.js @@ -10,7 +10,7 @@ class AddressBookController { * addresses and all currently owned addresses. * * @typedef {Object} AddressBookController - * @param {object} opts Overides the defaults for the initial state of this.store + * @param {object} opts Overrides the defaults for the initial state of this.store * @property {array} opts.initState initializes the the state of the AddressBookController. Can contain an * addressBook property to initialize the addressBook array * @param {KeyringController} keyringController (Soon to be deprecated) The keyringController used in the current diff --git a/app/scripts/controllers/currency.js b/app/scripts/controllers/currency.js index 6b166c151..c23c7f616 100644 --- a/app/scripts/controllers/currency.js +++ b/app/scripts/controllers/currency.js @@ -10,7 +10,7 @@ class CurrencyController { * Controller responsible for managing data associated with the currently selected currency. * * @typedef {Object} CurrencyController - * @param {object} opts Overides the defaults for the initial state of this.store + * @param {object} opts Overrides the defaults for the initial state of this.store * @property {array} opts.initState initializes the the state of the CurrencyController. Can contain an * currentCurrency, conversionRate and conversionDate properties * @property {string} currentCurrency A 2-4 character shorthand that describes a specific currency, currently diff --git a/app/scripts/controllers/preferences.js b/app/scripts/controllers/preferences.js index 92c016309..cf0ca13a8 100644 --- a/app/scripts/controllers/preferences.js +++ b/app/scripts/controllers/preferences.js @@ -7,7 +7,7 @@ class PreferencesController { /** * * @typedef {Object} PreferencesController - * @param {object} opts Overides the defaults for the initial state of this.store + * @param {object} opts Overrides the defaults for the initial state of this.store * @property {object} store The an object containing a users preferences, stored in local storage * @property {array} store.frequentRpcList A list of custom rpcs to provide the user * @property {string} store.currentAccountTab Indicates the selected tab in the ui diff --git a/app/scripts/controllers/shapeshift.js b/app/scripts/controllers/shapeshift.js index 10753b722..17994d2db 100644 --- a/app/scripts/controllers/shapeshift.js +++ b/app/scripts/controllers/shapeshift.js @@ -11,7 +11,7 @@ class ShapeshiftController { * that queries a shapeshift.io API for updates to any pending shapeshift transactions * * @typedef {Object} ShapeshiftController - * @param {object} opts Overides the defaults for the initial state of this.store + * @param {object} opts Overrides the defaults for the initial state of this.store * @property {array} opts.initState initializes the the state of the ShapeshiftController. Can contain an * shapeShiftTxList array. * @property {array} shapeShiftTxList An array of ShapeShiftTx objects diff --git a/app/scripts/lib/buy-eth-url.js b/app/scripts/lib/buy-eth-url.js index c7c7bc33c..4e2d0bc79 100644 --- a/app/scripts/lib/buy-eth-url.js +++ b/app/scripts/lib/buy-eth-url.js @@ -6,8 +6,9 @@ module.exports = getBuyEthUrl * @param {object} opts Options required to determine the correct url * @param {string} opts.network The network for which to return a url * @param {string} opts.amount The amount of ETH to buy on coinbase. Only relevant if network === '1'. - * @param {string} opts.address The adderss the bought ETH should be sent to. Only relevant if network === '1'. - * @returns {string} The url at which the user can access ETH, while in the given network + * @param {string} opts.address The address the bought ETH should be sent to. Only relevant if network === '1'. + * @returns {string|undefined} The url at which the user can access ETH, while in the given network. If the passed + * network does not match any of the specified cases, or if no network is given, returns undefined. * */ function getBuyEthUrl ({ network, amount, address }) { diff --git a/app/scripts/lib/nodeify.js b/app/scripts/lib/nodeify.js index 0a3891ac3..25be6537b 100644 --- a/app/scripts/lib/nodeify.js +++ b/app/scripts/lib/nodeify.js @@ -3,7 +3,7 @@ const noop = function () {} /** * A generator that returns a function which, when passed a promise, can treat that promise as a node style callback. - * The primse advantage being that callbacks are better for error handling. + * The prime advantage being that callbacks are better for error handling. * * @param {Function} fn The function to handle as a callback * @param {Object} context The context in which the fn is to be called, most often a this reference