chore: add typedefs

This commit is contained in:
Vasco Santos
2020-11-16 11:56:18 +01:00
parent dfcce961bd
commit 26c40c8dfd
30 changed files with 385 additions and 186 deletions

View File

@ -6,12 +6,17 @@ const errCode = require('err-code')
const { codes } = require('./errors')
/**
* @typedef {import('peer-id')} PeerId
* @typedef {import('multiaddr')} multiaddr
*/
/**
* Converts the given `peer` to a `Peer` object.
* If a multiaddr is received, the addressBook is updated.
*
* @param {PeerId|Multiaddr|string} peer
* @returns {{ id: PeerId, multiaddrs: Array<Multiaddr> }}
* @param {PeerId|multiaddr|string} peer
* @returns {{ id: PeerId, multiaddrs: Array<multiaddr> }}
*/
function getPeer (peer) {
if (typeof peer === 'string') {