chore: lint issue fixed 0.30

This commit is contained in:
Vasco Santos 2020-10-07 17:29:42 +02:00
parent 05e6472cce
commit 2530b834a1
5 changed files with 22 additions and 13 deletions

View File

@ -19,10 +19,11 @@ const hopMetadataValue = 'true'
class AutoRelay { class AutoRelay {
/** /**
* Creates an instance of AutoRelay. * Creates an instance of AutoRelay.
* @constructor *
* @class
* @param {object} props * @param {object} props
* @param {Libp2p} props.libp2p * @param {Libp2p} props.libp2p
* @param {number} [props.maxListeners = 1] maximum number of relays to listen. * @param {number} [props.maxListeners = 1] - maximum number of relays to listen.
*/ */
constructor ({ libp2p, maxListeners = 1 }) { constructor ({ libp2p, maxListeners = 1 }) {
this._libp2p = libp2p this._libp2p = libp2p
@ -50,10 +51,11 @@ class AutoRelay {
* If the protocol is not supported, check if it was supported before and remove it as a listen relay. * If the protocol is not supported, check if it was supported before and remove it as a listen relay.
* If the protocol is supported, check if the peer supports **HOP** and add it as a listener if * If the protocol is supported, check if the peer supports **HOP** and add it as a listener if
* inside the threshold. * inside the threshold.
*
* @param {Object} props * @param {Object} props
* @param {PeerId} props.peerId * @param {PeerId} props.peerId
* @param {Array<string>} props.protocols * @param {Array<string>} props.protocols
* @return {Promise<void>} * @returns {Promise<void>}
*/ */
async _onProtocolChange ({ peerId, protocols }) { async _onProtocolChange ({ peerId, protocols }) {
const id = peerId.toB58String() const id = peerId.toB58String()
@ -92,8 +94,9 @@ class AutoRelay {
/** /**
* Peer disconnects. * Peer disconnects.
* @param {Connection} connection connection to the peer *
* @return {void} * @param {Connection} connection - connection to the peer
* @returns {void}
*/ */
_onPeerDisconnected (connection) { _onPeerDisconnected (connection) {
const peerId = connection.remotePeer const peerId = connection.remotePeer
@ -109,10 +112,11 @@ class AutoRelay {
/** /**
* Attempt to listen on the given relay connection. * Attempt to listen on the given relay connection.
*
* @private * @private
* @param {Connection} connection connection to the peer * @param {Connection} connection - connection to the peer
* @param {string} id peer identifier string * @param {string} id - peer identifier string
* @return {Promise<void>} * @returns {Promise<void>}
*/ */
async _addListenRelay (connection, id) { async _addListenRelay (connection, id) {
// Check if already listening on enough relays // Check if already listening on enough relays
@ -152,9 +156,10 @@ class AutoRelay {
/** /**
* Remove listen relay. * Remove listen relay.
*
* @private * @private
* @param {string} id peer identifier string. * @param {string} id - peer identifier string.
* @return {void} * @returns {void}
*/ */
_removeListenRelay (id) { _removeListenRelay (id) {
if (this._listenRelays.delete(id)) { if (this._listenRelays.delete(id)) {
@ -169,8 +174,9 @@ class AutoRelay {
* 1. Check the metadata store for known relays, try to listen on the ones we are already connected. * 1. Check the metadata store for known relays, try to listen on the ones we are already connected.
* 2. Dial and try to listen on the peers we know that support hop but are not connected. * 2. Dial and try to listen on the peers we know that support hop but are not connected.
* 3. Search the network. * 3. Search the network.
*
* @param {Array<string>} [peersToIgnore] * @param {Array<string>} [peersToIgnore]
* @return {Promise<void>} * @returns {Promise<void>}
*/ */
async _listenOnAvailableHopRelays (peersToIgnore = []) { async _listenOnAvailableHopRelays (peersToIgnore = []) {
// TODO: The peer redial issue on disconnect should be handled by connection gating // TODO: The peer redial issue on disconnect should be handled by connection gating

View File

@ -118,8 +118,9 @@ module.exports.hop = async function hop ({
/** /**
* Performs a CAN_HOP request to a relay peer, in order to understand its capabilities. * Performs a CAN_HOP request to a relay peer, in order to understand its capabilities.
*
* @param {object} options * @param {object} options
* @param {Connection} options.connection Connection to the relay * @param {Connection} options.connection - Connection to the relay
* @returns {Promise<boolean>} * @returns {Promise<boolean>}
*/ */
module.exports.canHop = async function canHop ({ module.exports.canHop = async function canHop ({

View File

@ -128,6 +128,7 @@ class IdentifyService {
/** /**
* Calls `push` for all peers in the `peerStore` that are connected * Calls `push` for all peers in the `peerStore` that are connected
*
* @returns {void} * @returns {void}
*/ */
pushToPeerStore () { pushToPeerStore () {

View File

@ -5,6 +5,7 @@ const PeerRecord = require('./peer-record')
/** /**
* Create (or update if existing) self peer record and store it in the AddressBook. * Create (or update if existing) self peer record and store it in the AddressBook.
*
* @param {libp2p} libp2p * @param {libp2p} libp2p
* @returns {Promise<void>} * @returns {Promise<void>}
*/ */

View File

@ -141,7 +141,7 @@ class TransportManager {
* Starts listeners for each listen Multiaddr. * Starts listeners for each listen Multiaddr.
* *
* @async * @async
* @param {Array<Multiaddr>} addrs addresses to attempt to listen on * @param {Array<Multiaddr>} addrs - addresses to attempt to listen on
*/ */
async listen (addrs) { async listen (addrs) {
if (!addrs || addrs.length === 0) { if (!addrs || addrs.length === 0) {