chore: remove peer-info from api #34
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vasco-santos
force-pushed
the
chore/remove-peer-info-from-api
branch
2 times, most recently
from
e475c19 to
ec9ad61
Compare
BREAKING CHANGE: findProviders returns id and addrs properties instead of peer-info instance
vasco-santos
force-pushed
the
chore/remove-peer-info-from-api
branch
from
ec9ad61 to
c7f7e2d
Compare
jacobheun
reviewed
Apr 21, 2020
src/index.js
Outdated
| @@ -63,7 +62,7 @@ class DelegatedContentRouting { | |||
| * @param {object} options | |||
| * @param {number} options.timeout How long the query can take. Defaults to 30 seconds | |||
| * @param {number} options.numProviders How many providers to find, defaults to 20 | |||
| * @returns {AsyncIterable<PeerInfo>} | |||
| * @returns {AsyncIterable<{ id: PeerId, addrs: Multiaddr[] }>} | |||
There was a problem hiding this comment.
As mentioned in, libp2p/js-libp2p-delegated-peer-routing#25, I think we should make this return { id, multiaddrs } for api consistency.
|
Included in beta release dist-tags:
beta: 0.5.0 latest: 0.4.5 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the context of deprecating
peer-infoas described on libp2p/js-libp2p#589, this PR removes thepeer-infofrom being returned in the API, in favour of returning{ id, addrs }in the same way as ipfs does.BREAKING CHANGE: findProviders returns id and addrs properties instead of peer-info instance
Needs: