From: Yongfeng LI <wliyongfeng@gmail.com>
Date: Tue, 15 May 2018 10:34:31 +0000 (+0800)
Subject: add balances api doc
X-Git-Tag: v1.0.1~17
X-Git-Url: http://git.osdn.net/view?p=bytom%2Fbytom-node-sdk.git;a=commitdiff_plain;h=4d454354e6e9c91d2bcf31a2aec36d01ed0dcd30

add balances api doc
---

diff --git a/src/api/balances.js b/src/api/balances.js
index 4f5bb69..e7a776a 100644
--- a/src/api/balances.js
+++ b/src/api/balances.js
@@ -1,5 +1,40 @@
+/**
+ * Any balance on the blockchain is simply a summation of unspent outputs.
+ *
+ * @typedef {Object} Balance
+ * @global
+ *
+ * @property {Number} amount
+ * Sum of the unspent outputs.
+ *
+ * @property {String} account_alias
+ * Account alias.
+ *
+ * @property {String} account_id
+ * Account id.
+ *
+ * @property {String} asset_id
+ * Asset id.
+ *
+ * @property {String} asset_alias
+ * Asset alias.
+ *
+ * @property {Object} asset_definition
+ * Asset definition
+ */
+
+/**
+ * API for interacting with {@link Balance balances}.
+ *
+ * @module BalancesApi
+ */
 const balancesApi = (connection) => {
   return {
+    /**
+     * Get all asset balances of all accounts.
+     *
+     * @returns {Promise<Array<Balance>>} The result balances.
+     */
     list: () => connection.request('/list-balances', {})
   }
 }