Skip to content
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.

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

Already on GitHub? Sign in to your account

Rework examples to be a bit more specific #1352

Merged
merged 4 commits into from Nov 17, 2021

Conversation

cruxicheiros
Copy link
Contributor

Firstly: I love this module, it's really helpful and I use it all the time.

I was using this module with TypeScript for the first time today and found the docs a bit confusing. I made these changes because I would have liked to have had this information up front and labelled more clearly:

  • How to import the contents of MQTT.js in more than one import style
  • A TypeScript example showing off one of the types in MQTT.js

I also added the WeChat and AliPay protocols to the list of the supported protocols because I thought it was a bit weird that they were listed in their own section but not there, and restructured the section to only contain one example of the specific usage to make it clearer what's different there.

Thank you! 馃槃

Copy link
Contributor

@YoDaMa YoDaMa left a comment

Choose a reason for hiding this comment

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

lgtm. Thanks for your contribution. Be on the lookout in the coming months for the next generation release of this package. We will be moving to Promise-based API and Typescript, and looking for good user feedback.

@YoDaMa YoDaMa merged commit 2e845f3 into mqttjs:master Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants