diff --git a/doc/API.md b/doc/API.md index ee4af9c7..eb0c4d69 100644 --- a/doc/API.md +++ b/doc/API.md @@ -760,7 +760,7 @@ Get the known [`Addresses`][address] of a provided peer. | Type | Description | |------|-------------| -| `Array
` | Array of peer's [`Addresses`][address] containing the multiaddr and its metadata | +| `Array
|undefined` | Array of peer's [`Addresses`][address] containing the multiaddr and its metadata if available, otherwise undefined | #### Example @@ -797,7 +797,7 @@ Get the known `Multiaddr` of a provided peer. All returned multiaddrs will inclu | Type | Description | |------|-------------| -| `Array` | Array of peer's multiaddr | +| `Array|undefined` | Array of peer's multiaddr if available, otherwise undefined | #### Example diff --git a/src/peer-store/address-book.js b/src/peer-store/address-book.js index 7841a320..5ace70b8 100644 --- a/src/peer-store/address-book.js +++ b/src/peer-store/address-book.js @@ -168,8 +168,9 @@ class AddressBook extends Book { /** * Get the known multiaddrs for a given peer. All returned multiaddrs * will include the encapsulated `PeerId` of the peer. + * Returns `undefined` if there are no known multiaddrs for the given peer. * @param {PeerId} peerId - * @returns {Array} + * @returns {Array|undefined} */ getMultiaddrsForPeer (peerId) { if (!PeerId.isPeerId(peerId)) { diff --git a/src/peer-store/book.js b/src/peer-store/book.js index 34d77e1d..8827c9fa 100644 --- a/src/peer-store/book.js +++ b/src/peer-store/book.js @@ -77,8 +77,9 @@ class Book { /** * Get the known data of a provided peer. + * Returns `undefined` if there is no available data for the given peer. * @param {PeerId} peerId - * @returns {Array} + * @returns {Array|undefined} */ get (peerId) { if (!PeerId.isPeerId(peerId)) {