Docs: instance.publish(packet) expects an aedes-packet object #70
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
… an mqtt-packet Updated the docs to match the new parameter expectation.
mcollina
reviewed
Oct 3, 2016
| @@ -143,7 +143,7 @@ It supports backpressure. | |||
| ### instance.publish(packet, done) | |||
|
|
|||
| Publish the given packet to subscribed clients and functions. A packet | |||
| must be valid for [mqtt-packet](http://npm.im/mqtt-packet). | |||
| must be valid for [aedes-packet](http://npm.im/aedes-packet). | |||
There was a problem hiding this comment.
In aedes-packet, everything is defaulted:
https://github.com/mcollina/aedes-packet/blob/master/packet.js#L4-L11.
I think a much better definition can be: a packet must have the following properties...
There was a problem hiding this comment.
@mcollina I think you have outlined it well here:
https://www.npmjs.com/package/mqtt-packet#publish
Should I just copy over that explanation?
There was a problem hiding this comment.
@mcollina Updated the PR 😄 Let me know if anything is missing.
Uses modified description from https://www.npmjs.com/package/mqtt-packet#publish according to properties expected and extracted in aedes-packet: https://github.com/mcollina/aedes-packet/blob/master/packet.js#L4-L11
|
Perfect, thanks! |
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.
Updated the docs to match the new parameter expectation.