add unspent outputs api doc

diff --git a/src/api/unspentOutputs.js b/src/api/unspentOutputs.js
index 0ef0729..2afa264 100644 (file)
--- a/src/api/unspentOutputs.js
+++ b/src/api/unspentOutputs.js
@@ -1,7 +1,70 @@
+/**
+ * Each new transaction in the blockchain consumes some unspent outputs and
+ * creates others. An output is considered unspent when it has not yet been used
+ * as an input to a new transaction. All asset units on a blockchain exist in
+ * the unspent output set.
+ *
+ * @typedef {Object} UnspentOutput
+ * @global
+ *
+ * @property {String} account_alias
+ * The alias of the account transferring the asset (possibly null).
+ *
+ * @property {String} account_id
+ * The id of the account transferring the asset (possibly null).
+ *
+ * @property {String} address
+ * The output address.
+ *
+ * @property {String} id
+ * Unique transaction identifier.
+ *
+ * @property {Number} amount
+ * The number of units of the asset being issued or spent.
+ *
+ * @property {String} asset_alias
+ * The alias of the asset being issued or spent (possibly null).
+ *
+ * @property {String} asset_id
+ * The id of the asset being issued or spent.
+ *
+ * @property {Number} source_pos
+ * The output's position in a transaction's list of outputs.
+ *
+ * @property {Boolean} change
+ * Whether this output is asset change of one spend.
+ *
+ * @property {Number} control_program_index
+ * Control program index.
+ *
+ * @property {String} program
+ * The control program which must be satisfied to transfer this output.
+ *
+ * @property {String} source_id
+ * The source unspent output id.
+ *
+ * @property {Number} valid_height
+ * It means coinbase utxo if valid_height > 0.
+ */
+
+/**
+ * API for interacting with {@link UnspentOutput unspent outputs}.
+ *
+ * @module UnspentOutputsApi
+ */
 const unspentOutputsAPI = (connection) => {
   return {
+    /**
+     * Get all unspent outputs.
+     * @returns {Promise<Array<UnspentOutput>>} Target unspent outputs.
+     */
     list: () => connection.request('/list-unspent-outputs', {}),
 
+    /**
+     * Get target unspent outputs by id.
+     * @param {String} id - Unspent output id.
+     * @returns {Promise<Array<UnspentOutput>>} Target unspent outputs.
+     */
     listById: (id) => connection.request('list-unspent-outputs', {id})
   }
 }