Update jsdoc

danakt · danakt · commit 59a7491b8a2d · 2018-03-05T01:53:01.000+03:00
diff --git a/doc/API.md b/doc/API.md
@@ -27,13 +27,13 @@ EtherscanApi
     * [.getTransactionByHash(txhash)](#EtherscanApi+getTransactionByHash) ⇒ <code>Promise.&lt;object&gt;</code>
     * [.getTransactionByBlockNumberAndIndex(blockNumber, [index])](#EtherscanApi+getTransactionByBlockNumberAndIndex) ⇒ <code>Promise.&lt;object&gt;</code>
     * [.getTransactionCount(address)](#EtherscanApi+getTransactionCount) ⇒ <code>Promise.&lt;number&gt;</code>
-    * [.sendRawTransaction(hex)](#EtherscanApi+sendRawTransaction)
+    * [.sendRawTransaction(hex)](#EtherscanApi+sendRawTransaction) ⇒ <code>Promise.&lt;void&gt;</code>
     * [.getTransactionReceipt(txhash)](#EtherscanApi+getTransactionReceipt) ⇒ <code>Promise.&lt;object&gt;</code>
     * [.call(to, data)](#EtherscanApi+call) ⇒ <code>Promise.&lt;string&gt;</code>
     * [.getCode(address)](#EtherscanApi+getCode) ⇒ <code>Promise.&lt;string&gt;</code>
     * [.getStorageAt(address, position)](#EtherscanApi+getStorageAt) ⇒ <code>Promise.&lt;string&gt;</code>
-    * [.getGasPrice([unit])](#EtherscanApi+getGasPrice) ⇒ <code>string</code>
-    * [.estimateGas(to, value, gasPrice, gas)](#EtherscanApi+estimateGas)
+    * [.getGasPrice([unit])](#EtherscanApi+getGasPrice) ⇒ <code>Promise.&lt;string&gt;</code>
+    * [.estimateGas(to, value, gasPrice, gas)](#EtherscanApi+estimateGas) ⇒ <code>Promise.&lt;void&gt;</code>
     * [.getTokenByContractAddress(contractAddress)](#EtherscanApi+getTokenByContractAddress) ⇒ <code>Promise.&lt;string&gt;</code>
     * [.getTokenBalanceByContractAddress(contractAddress)](#EtherscanApi+getTokenBalanceByContractAddress) ⇒ <code>Promise.&lt;string&gt;</code>
     * [.getTotalEtherSupply()](#EtherscanApi+getTotalEtherSupply) ⇒ <code>Promise.&lt;string&gt;</code>
@@ -283,7 +283,7 @@ Returns the number of transactions sent from an address
 
 <a name="EtherscanApi+sendRawTransaction"></a>
 
-### etherscanApi.sendRawTransaction(hex)
+### etherscanApi.sendRawTransaction(hex) ⇒ <code>Promise.&lt;void&gt;</code>
 Creates new message call transaction or a contract creation for signed
 transactions
 
@@ -342,7 +342,7 @@ Returns the value from a storage position at a given address.
 
 <a name="EtherscanApi+getGasPrice"></a>
 
-### etherscanApi.getGasPrice([unit]) ⇒ <code>string</code>
+### etherscanApi.getGasPrice([unit]) ⇒ <code>Promise.&lt;string&gt;</code>
 Returns the current price per gas (in wei by default)
 
 **Kind**: instance method of [<code>EtherscanApi</code>](#EtherscanApi)  
@@ -353,7 +353,7 @@ Returns the current price per gas (in wei by default)
 
 <a name="EtherscanApi+estimateGas"></a>
 
-### etherscanApi.estimateGas(to, value, gasPrice, gas)
+### etherscanApi.estimateGas(to, value, gasPrice, gas) ⇒ <code>Promise.&lt;void&gt;</code>
 Makes a call or transaction, which won't be added to the blockchain and
 returns the used gas, which can be used for estimating the used gas
 
diff --git a/index.d.ts b/index.d.ts
@@ -532,7 +532,7 @@ declare class EtherscanApi {
   /**
    * Returns the current price per gas (in wei by default)
    * @param {string} [unit=wei] Unit of gas
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   getGasPrice(unit?: keyof UNITS): Promise<string>
 
@@ -543,6 +543,7 @@ declare class EtherscanApi {
    * @param {string} value Storage position
    * @param {string} gasPrice Gas price in wei
    * @param {string} gas
+   * @returns {Promise<void>}
    */
   estimateGas(
     to: string,
diff --git a/src/EtherscanApi.js b/src/EtherscanApi.js
@@ -378,6 +378,7 @@ class EtherscanApi {
    * Creates new message call transaction or a contract creation for signed
    * transactions
    * @param {string} hex Raw hex encoded transaction that you want to send
+   * @return {Promise<void>}
    */
   sendRawTransaction(hex) {
     this._createRequest({
@@ -450,7 +451,7 @@ class EtherscanApi {
   /**
    * Returns the current price per gas (in wei by default)
    * @param {string} [unit=wei] Unit of gas
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   getGasPrice(unit = 'wei') {
     return this._createRequest({
@@ -477,6 +478,7 @@ class EtherscanApi {
    * @param {string} value Storage position
    * @param {string} gasPrice Gas price in wei
    * @param {string} gas
+   * @return {Promise<void>}
    */
   estimateGas(to, value, gasPrice, gas) {
     this._createRequest({
