docs: use tag for webrtc-star discovery config #713
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
jacobheun
reviewed
Jul 20, 2020
| @@ -304,7 +304,7 @@ const node = await Libp2p.create({ | |||
| }, | |||
| config: { | |||
| peerDiscovery: { | |||
| webRTCStar: { | |||
| [WebRTCStar.tag]: { | |||
There was a problem hiding this comment.
This is referenced in the same file further down as WebRTCStar.prototype[Symbol.toStringTag], we should probably keep that consistent.
There was a problem hiding this comment.
That is a good point! We are using the tag's for discovery configurations everywhere. I also saw the WebRTCStar.prototype[Symbol.toStringTag] and it is being used for the configuration of a transport.
I think we should clean this up in #576 , but now I think we should guarantee consistency between all the discovery services. For transport configuration, we should use the symbol property. While for webrtct, it will be the same, for other transport/discovery it will not be.
jacobheun
approved these changes
Jul 20, 2020
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.
To avoid confusions like we previously had. This was not fixed at the time