fix: dial protocol should throw if no protocol is provided #914
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
BREAKING CHANGE: dialProtocol does not return connection when no protocols are provided
achingbrain
reviewed
Apr 16, 2021
src/index.js
Outdated
| * | ||
| * @async | ||
| * @param {PeerId|Multiaddr|string} peer - The peer to dial | ||
| * @param {string[]|string} protocols | ||
| * @param {object} [options] | ||
| * @param {AbortSignal} [options.signal] | ||
| * @returns {Promise<Connection|{ stream: MuxedStream; protocol: string; }>} | ||
| * @returns {Promise<{ stream: MuxedStream; protocol: string; }>} |
There was a problem hiding this comment.
Could remove the @returns annotation altogether?
vasco-santos
commented
Apr 16, 2021
vasco-santos
deleted the
fix/dial-protocol-should-throw-if-no-protocol-provided
branch
77 tasks
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.
This makes ts projects using dialProtocol to have to validate wether a stream pair object or a connection is returned. Moreover, returning different types conditionally is not really a good practise.
We should consider in the future to just deprecate
dialProtocolas users can now easily open streams from a given connectionBREAKING CHANGE: dialProtocol does not return connection when no protocols are provided