fluencelabs/js-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p synced 2025-03-28 05:11:04 +00:00
Code Issues Projects Releases Wiki Activity

chore: add notice for addressBook.set

Browse Source
This commit is contained in:
Vasco Santos 2020-07-22 16:31:24 +02:00 committed by Jacob Heun
parent ca57e65ecc
commit cd09327eb6
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/API.md
View File

@ -814,7 +814,8 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
### peerStore.addressBook.set ### peerStore.addressBook.set
Set known `multiaddrs` of a given peer. 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.
`peerStore.addressBook.set(peerId, multiaddrs)` `peerStore.addressBook.set(peerId, multiaddrs)`

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

@ -158,6 +158,8 @@ class AddressBook extends Book {
/** /**
* Set known multiaddrs of a provided peer. * 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.
* @override * @override
* @param {PeerId} peerId * @param {PeerId} peerId
* @param {Array<Multiaddr>} multiaddrs * @param {Array<Multiaddr>} multiaddrs