mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-16 15:40:49 +00:00
chore: add notice for addressBook.set
This commit is contained in:
parent
ca57e65ecc
commit
cd09327eb6
@ -814,7 +814,8 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
|
||||
|
||||
### 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)`
|
||||
|
||||
|
@ -158,6 +158,8 @@ 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.
|
||||
* @override
|
||||
* @param {PeerId} peerId
|
||||
* @param {Array<Multiaddr>} multiaddrs
|
||||
|
Loading…
x
Reference in New Issue
Block a user