docs: improve JSDocs

dashpay · Oct 24, 2024 · 6a5f378 · 6a5f378
1 parent 10f88c1
commit 6a5f378
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/packages/dapi/lib/externalApis/tenderdash/requestTenderRpc.js b/packages/dapi/lib/externalApis/tenderdash/requestTenderRpc.js
@@ -4,16 +4,17 @@ const RPCError = require('../../rpcServer/RPCError');
 
 /**
  * @param {jaysonClient} rpcClient
- * @return {requestTenderRpc}
+ * @return {requestTenderRpc} A function to make RPC requests to Tenderdash.
  */
 function requestTenderRpcFactory(rpcClient) {
   /**
+   * @function
    * @typedef requestTenderRpc
    * @param {string} uri
-   * @param {Object} [params]
+   * @param {Object} [params={}]
    * @return {Promise<Object>}
    */
-  return async function requestTenderRpc(uri, params = {}) {
+  async function requestTenderRpc(uri, params = {}) {
     let response;
     try {
       response = await rpcClient.request(uri, params);
@@ -44,7 +45,9 @@ function requestTenderRpcFactory(rpcClient) {
     }
 
     return result;
-  };
+  }
+
+  return requestTenderRpc;
 }
 
 module.exports = requestTenderRpcFactory;