diff --git a/src/circuit/index.js b/src/circuit/index.js index dbb70e61..d12d8824 100644 --- a/src/circuit/index.js +++ b/src/circuit/index.js @@ -37,6 +37,7 @@ class Relay { /** * Start Relay service. + * * @returns {void} */ start () { @@ -52,6 +53,7 @@ class Relay { /** * Stop Relay service. + * * @returns {void} */ stop () { @@ -60,6 +62,7 @@ class Relay { /** * Advertise hop relay service in the network. + * * @returns {Promise} */ async _advertiseService () { diff --git a/src/circuit/transport.js b/src/circuit/transport.js index e876fa60..cc798705 100644 --- a/src/circuit/transport.js +++ b/src/circuit/transport.js @@ -22,7 +22,7 @@ class Circuit { /** * Creates an instance of the Circuit Transport. * - * @constructor + * @class * @param {object} options * @param {Libp2p} options.libp2p * @param {Upgrader} options.upgrader @@ -159,7 +159,7 @@ class Circuit { * * @param {any} options * @param {Function} handler - * @return {listener} + * @returns {listener} */ createListener (options, handler) { if (typeof options === 'function') { diff --git a/src/circuit/utils.js b/src/circuit/utils.js index 7426271c..18b61eaf 100644 --- a/src/circuit/utils.js +++ b/src/circuit/utils.js @@ -5,8 +5,9 @@ const multihashing = require('multihashing-async') /** * Convert a namespace string into a cid. + * * @param {string} namespace - * @return {Promise} + * @returns {Promise} */ module.exports.namespaceToCid = async (namespace) => { const bytes = new TextEncoder('utf8').encode(namespace)