fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-03-16 15:40:49 +00:00
Code Issues Projects Releases Wiki Activity

chore: apply suggestions from code review

Browse Source 
Co-authored-by: Jacob Heun <jacobheun@gmail.com>
This commit is contained in:
Vasco Santos 2020-07-23 13:46:34 +02:00 committed by Jacob Heun
parent cd09327eb6
commit 9107efe121
2 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/API.md
View File

@ -816,6 +816,7 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
Set known `multiaddrs` of a given peer. This will replace previously stored multiaddrs, if available.
Replacing stored multiaddrs might result in losing obtained certified addresses, which is not desirable.
Consider using `addressBook.add()` if you're not sure this is what you want to do.
`peerStore.addressBook.set(peerId, multiaddrs)`

1
src/peer-store/address-book.js
View File

@ -160,6 +160,7 @@ class AddressBook extends Book {
* Set known multiaddrs of a provided peer.
* This will replace previously stored multiaddrs, if available.
* Replacing stored multiaddrs might result in losing obtained certified addresses.
* If you are not sure, it's recommended to use `add` instead.
* @override
* @param {PeerId} peerId
* @param {Array<Multiaddr>} multiaddrs