Skip to content

Commit 02b6248

Browse files
chore: apply suggestions from code review
Co-authored-by: Jacob Heun <jacobheun@gmail.com>
1 parent 7681a19 commit 02b6248

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

doc/API.md

+1
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,7 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
816816

817817
Set known `multiaddrs` of a given peer. This will replace previously stored multiaddrs, if available.
818818
Replacing stored multiaddrs might result in losing obtained certified addresses, which is not desirable.
819+
Consider using `addressBook.add()` if you're not sure this is what you want to do.
819820

820821
`peerStore.addressBook.set(peerId, multiaddrs)`
821822

src/peer-store/address-book.js

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

0 commit comments

Comments
 (0)