aboutsummaryrefslogtreecommitdiffstats
path: root/app/scripts/controllers/computed-balances.js
diff options
context:
space:
mode:
authorbitpshr <mail@bitpshr.net>2018-04-20 03:12:04 +0800
committerbitpshr <mail@bitpshr.net>2018-04-20 03:14:00 +0800
commit8636f3bae547ace7d099a3ed516bf013dfe3858e (patch)
tree179fd228bbf833709d70ed68b54cbb33c089ebda /app/scripts/controllers/computed-balances.js
parent9c7eafc86f1d9d06dd6a5b66ecd2154b09299d03 (diff)
downloadtangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.gz
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.bz2
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.lz
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.xz
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.zst
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.zip
Clean up JSDoc for background scripts
Diffstat (limited to 'app/scripts/controllers/computed-balances.js')
-rw-r--r--app/scripts/controllers/computed-balances.js12
1 files changed, 10 insertions, 2 deletions
diff --git a/app/scripts/controllers/computed-balances.js b/app/scripts/controllers/computed-balances.js
index cf2e05333..1a6802f9a 100644
--- a/app/scripts/controllers/computed-balances.js
+++ b/app/scripts/controllers/computed-balances.js
@@ -3,6 +3,14 @@ const extend = require('xtend')
const BalanceController = require('./balance')
/**
+ * @typedef {Object} ComputedBalancesOptions
+ * @property {Object} accountTracker Account tracker store reference
+ * @property {Object} txController Token controller reference
+ * @property {Object} blockTracker Block tracker reference
+ * @property {Object} initState Initial state to populate this internal store with
+ */
+
+/**
* Background controller responsible for syncing
* and computing ETH balances for all accounts
*/
@@ -10,7 +18,7 @@ class ComputedbalancesController {
/**
* Creates a new controller instance
*
- * @param {Object} [opts] Controller configuration parameters
+ * @param {ComputedBalancesOptions} [opts] Controller configuration parameters
*/
constructor (opts = {}) {
const { accountTracker, txController, blockTracker } = opts
@@ -52,7 +60,7 @@ class ComputedbalancesController {
* Uses current account state to sync and track all
* addresses associated with the current account
*
- * @param {Object} store Account tracking state
+ * @param {{ accounts: Object }} store Account tracking state
*/
syncAllAccountsFromStore (store) {
const upstream = Object.keys(store.accounts)