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

feat!: rename peer discovery symbol to peerDiscovery #394

Merged
merged 2 commits into from
May 4, 2023

Conversation

achingbrain
Copy link
Member

The export symbol from the @libp2p/interface-peer-discovery is too generic to use with modules that might implement peer discovery and something else so it's been renamed to peerDiscovery.

Objects with peerDiscovery symbol properties getters should return PeerDiscovery instances instead of boolean values.

BREAKING CHANGE: the symbol export is now named peerDiscovery

The export `symbol` from the `@libp2p/interface-peer-discovery` is too
generic to use with modules that might implement peer discovery and
something else so it's been renamed to `peerDiscovery`.

Objects with `peerDiscovery` symbol properties getters should return
`PeerDiscovery` instances instead of `boolean` values.

BREAKING CHANGE: the `symbol` export is now named `peerDiscovery`
@achingbrain achingbrain merged commit 5957c77 into master May 4, 2023
@achingbrain achingbrain deleted the fix/update-peer-discovery branch May 4, 2023 17:22
github-actions bot pushed a commit that referenced this pull request May 4, 2023
## [@libp2p/interface-peer-discovery-v2.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-peer-discovery-v1.1.1...@libp2p/interface-peer-discovery-v2.0.0) (2023-05-04)

### ⚠ BREAKING CHANGES

* the `symbol` export is now named `peerDiscovery` and the getter with that name should return an instance of `PeerDiscovery`

### Features

* rename peer discovery symbol to peerDiscovery ([#394](#394)) ([5957c77](5957c77))
@github-actions
Copy link

github-actions bot commented May 4, 2023

🎉 This PR is included in version @libp2p/interface-peer-discovery-v2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this pull request May 4, 2023
## [@libp2p/interface-mocks-v12.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-mocks-v11.0.3...@libp2p/interface-mocks-v12.0.0) (2023-05-04)

### ⚠ BREAKING CHANGES

* the `symbol` export is now named `peerDiscovery` and the getter with that name should return an instance of `PeerDiscovery`

### Features

* rename peer discovery symbol to peerDiscovery ([#394](#394)) ([5957c77](5957c77))

### Dependencies

* update sibling dependencies ([45cf513](45cf513))
@github-actions
Copy link

github-actions bot commented May 4, 2023

🎉 This PR is included in version @libp2p/interface-mocks-v12.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant