Typo fixes, type fixes on the return clauses of the buyEthUrl and getPrefferedLangCode functions.

This commit is contained in:
Dan 2018-04-16 21:23:29 -02:30
parent cc7e71488e
commit e9ca7199ab
6 changed files with 8 additions and 7 deletions

View File

@ -10,7 +10,7 @@ class AddressBookController {
* addresses and all currently owned addresses. * addresses and all currently owned addresses.
* *
* @typedef {Object} AddressBookController * @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 * @property {array} opts.initState initializes the the state of the AddressBookController. Can contain an
* addressBook property to initialize the addressBook array * addressBook property to initialize the addressBook array
* @param {KeyringController} keyringController (Soon to be deprecated) The keyringController used in the current * @param {KeyringController} keyringController (Soon to be deprecated) The keyringController used in the current

View File

@ -10,7 +10,7 @@ class CurrencyController {
* Controller responsible for managing data associated with the currently selected currency. * Controller responsible for managing data associated with the currently selected currency.
* *
* @typedef {Object} CurrencyController * @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 * @property {array} opts.initState initializes the the state of the CurrencyController. Can contain an
* currentCurrency, conversionRate and conversionDate properties * currentCurrency, conversionRate and conversionDate properties
* @property {string} currentCurrency A 2-4 character shorthand that describes a specific currency, currently * @property {string} currentCurrency A 2-4 character shorthand that describes a specific currency, currently

View File

@ -7,7 +7,7 @@ class PreferencesController {
/** /**
* *
* @typedef {Object} 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 {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 {array} store.frequentRpcList A list of custom rpcs to provide the user
* @property {string} store.currentAccountTab Indicates the selected tab in the ui * @property {string} store.currentAccountTab Indicates the selected tab in the ui

View File

@ -11,7 +11,7 @@ class ShapeshiftController {
* that queries a shapeshift.io API for updates to any pending shapeshift transactions * that queries a shapeshift.io API for updates to any pending shapeshift transactions
* *
* @typedef {Object} ShapeshiftController * @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 * @property {array} opts.initState initializes the the state of the ShapeshiftController. Can contain an
* shapeShiftTxList array. * shapeShiftTxList array.
* @property {array} shapeShiftTxList An array of ShapeShiftTx objects * @property {array} shapeShiftTxList An array of ShapeShiftTx objects

View File

@ -6,8 +6,9 @@ module.exports = getBuyEthUrl
* @param {object} opts Options required to determine the correct url * @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.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.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'. * @param {string} opts.address The address 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 * @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 }) { function getBuyEthUrl ({ network, amount, address }) {

View File

@ -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. * 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 {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 * @param {Object} context The context in which the fn is to be called, most often a this reference