Skip to content
This repository was archived by the owner on Jun 26, 2023. It is now read-only.

Commit bdd2502

Browse files
vasco-santosjacobheun
authored andcommitted
feat: peer-discovery not using peer-info
BREAKING CHANGE: peer-discovery emits object with id and multiaddrs properties
1 parent 1bef8d5 commit bdd2502

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/peer-discovery/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,7 @@ It returns a `Promise`
7272

7373
- `discovery.on('peer', (peerInfo) => {})`
7474

75-
Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info).
75+
Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discovered peer's information, which must contain the following properties:
76+
77+
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerInfo.id`
78+
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerInfo.multiaddrs`

0 commit comments

Comments
 (0)