Skip to content

docs: use tag for webrtc-star discovery config #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 20, 2020
Merged

docs: use tag for webrtc-star discovery config #713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/CONFIGURATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ const node = await Libp2p.create({
},
config: {
peerDiscovery: {
webRTCStar: {
[WebRTCStar.tag]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is referenced in the same file further down as WebRTCStar.prototype[Symbol.toStringTag], we should probably keep that consistent.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

enabled: true
}
}
Expand Down