docs: add comment to simple-publish.js (binary msg) #2031
Conversation
This file contains hidden or 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
For a new user it can be confusing how to publish a binary message from the browser.
mjcross
changed the title
robertsLando
requested changes
Nov 8, 2025
Member
robertsLando
left a comment
robertsLando
left a comment
There was a problem hiding this comment.
I think this comment should be placed on readme instead
Author
|
Sounds good to me, @robertsLando - I'll have a look at that |
Illustrates how to publish a binary message (from a browser)
Author
|
@robertsLando hope this looks OK 91f6e46 |
robertsLando
requested changes
Nov 10, 2025
|
|
||
| - `topic` is the topic to publish to, `String` | ||
| - `message` is the message to publish, `Buffer` or `String` | ||
| - `message` is the message to publish, `Buffer` (in browser `Uint8Array`) or `String` |
Member
There was a problem hiding this comment.
I think this is enough, no need to also add an example
Author
There was a problem hiding this comment.
Sure - although as a user, I can say examples are incredibly valuable (and it also illustrates how to make a WSS connection, which gives a 'self contained' example for how to connect from a browser)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Just to add a short comment to the example, as a hint for users wanting to publish a binary message from the browser.
It can be confusing to know how to do that, when you don't have node.js
Bufferavailable.