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

Commit 170c2fd

Browse files
chore: apply suggestions from code review
Co-Authored-By: Jacob Heun <[email protected]>
1 parent 12f11c8 commit 170c2fd

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

src/peer-discovery/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ It returns a `Promise`
7070

7171
### discoverying peers
7272

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

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:
75+
Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties:
7676

77-
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerInfo.id`
78-
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerInfo.multiaddrs`
77+
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
78+
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`

src/peer-discovery/tests/index.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ module.exports = (common) => {
1919
discovery = await common.setup()
2020
})
2121

22-
after(() => common.teardown && common.teardown())
23-
2422
afterEach('ensure discovery was stopped', async () => {
2523
await discovery.stop()
2624

2725
discovery.removeAllListeners()
26+
27+
common.teardown && common.teardown()
2828
})
2929

3030
it('can start the service', async () => {
@@ -45,7 +45,7 @@ module.exports = (common) => {
4545
await discovery.start()
4646
})
4747

48-
it('should listen a peer event after start', async () => {
48+
it('should emit a peer event after start', async () => {
4949
const defer = pDefer()
5050
await discovery.start()
5151

@@ -59,7 +59,7 @@ module.exports = (common) => {
5959
defer.resolve()
6060
})
6161

62-
return defer.promise
62+
await defer.promise
6363
})
6464

6565
it('should not receive a peer event before start', async () => {

test/peer-discovery/compliance.spec.js

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ describe('compliance tests', () => {
88
let intervalId
99

1010
tests({
11-
async setup () {
12-
await new Promise(resolve => setTimeout(resolve, 10))
13-
11+
setup () {
1412
const mockDiscovery = new MockDiscovery({
1513
discoveryDelay: 1
1614
})
@@ -19,9 +17,8 @@ describe('compliance tests', () => {
1917

2018
return mockDiscovery
2119
},
22-
async teardown () {
20+
teardown () {
2321
clearInterval(intervalId)
24-
await new Promise(resolve => setTimeout(resolve, 10))
2522
}
2623
})
2724
})

0 commit comments

Comments
 (0)