diff --git a/README.md b/README.md
index eb4605a15..eec44db27 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,28 @@
-
-=======
+# 
- [](https://codecov.io/gh/mqttjs/MQTT.js)
+ [](https://codecov.io/gh/mqttjs/MQTT.js)
MQTT.js is a client library for the [MQTT](http://mqtt.org/) protocol, written
in JavaScript for node.js and the browser.
+> MQTT [5.0.0-beta.0](https://github.com/mqttjs/MQTT.js/releases/tag/v5.0.0-beta.0) is now available! Try it out and give us feedback! `npm i mqtt@5.0.0-beta.0`
+
## Table of Contents
-* [__MQTT.js vNext__](#vnext)
-* [Upgrade notes](#notes)
-* [Installation](#install)
-* [Example](#example)
-* [Import Styles](#example)
-* [Command Line Tools](#cli)
-* [API](#api)
-* [Browser](#browser)
-* [About QoS](#qos)
-* [TypeScript](#typescript)
-* [Weapp and Ali support](#weapp-alipay)
-* [Contributing](#contributing)
-* [License](#license)
+
+- [**MQTT.js vNext**](#vnext)
+- [Upgrade notes](#notes)
+- [Installation](#install)
+- [Example](#example)
+- [Import Styles](#example)
+- [Command Line Tools](#cli)
+- [API](#api)
+- [Browser](#browser)
+- [About QoS](#qos)
+- [TypeScript](#typescript)
+- [Weapp and Ali support](#weapp-alipay)
+- [Contributing](#contributing)
+- [Sponsor](#sponsor)
+- [License](#license)
MQTT.js is an OPEN Open Source Project, see the [Contributing](#contributing) section to find out what this means.
@@ -27,40 +30,45 @@ MQTT.js is an OPEN Open Source Project, see the [Contributing](#contributing) se
Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+
## Next major version of MQTT.js
+
There is work being done on the next generation of MQTT.js (vNext). We invite the community to provide their contributions [this repository](https://github.com/mqttjs/mqttjs-v5)
+
## Important notes for existing users
-__v4.0.0__ (Released 04/2020) removes support for all end of life node versions, and now supports node v12 and v14. It also adds improvements to
+**v5.0.0** (**BETA** 06/2023) removes support for all end of life node versions (v12 and v14), and now supports node v18 and v20.
+
+**v4.0.0** (Released 04/2020) removes support for all end of life node versions, and now supports node v12 and v14. It also adds improvements to
debug logging, along with some feature additions.
-As a __breaking change__, by default a error handler is built into the MQTT.js client, so if any
+As a **breaking change**, by default a error handler is built into the MQTT.js client, so if any
errors are emitted and the user has not created an event handler on the client for errors, the client will
not break as a result of unhandled errors. Additionally, typical TLS errors like `ECONNREFUSED`, `ECONNRESET` have been
added to a list of TLS errors that will be emitted from the MQTT.js client, and so can be handled as connection errors.
-__v3.0.0__ adds support for MQTT 5, support for node v10.x, and many fixes to improve reliability.
+**v3.0.0** adds support for MQTT 5, support for node v10.x, and many fixes to improve reliability.
-__Note:__ MQTT v5 support is experimental as it has not been implemented by brokers yet.
+**Note:** MQTT v5 support is experimental as it has not been implemented by brokers yet.
-__v2.0.0__ removes support for node v0.8, v0.10 and v0.12, and it is 3x faster in sending
+**v2.0.0** removes support for node v0.8, v0.10 and v0.12, and it is 3x faster in sending
packets. It also removes all the deprecated functionality in v1.0.0,
mainly `mqtt.createConnection` and `mqtt.Server`. From v2.0.0,
subscriptions are restored upon reconnection if `clean: true`.
-v1.x.x is now in *LTS*, and it will keep being supported as long as
+v1.x.x is now in _LTS_, and it will keep being supported as long as
there are v0.8, v0.10 and v0.12 users.
-As a __breaking change__, the `encoding` option in the old client is
+As a **breaking change**, the `encoding` option in the old client is
removed, and now everything is UTF-8 with the exception of the
`password` in the CONNECT message and `payload` in the PUBLISH message,
which are `Buffer`.
-Another __breaking change__ is that MQTT.js now defaults to MQTT v3.1.1,
+Another **breaking change** is that MQTT.js now defaults to MQTT v3.1.1,
so to support old brokers, please read the [client options doc](#client).
-__v1.0.0__ improves the overall architecture of the project, which is now
+**v1.0.0** improves the overall architecture of the project, which is now
split into three components: MQTT.js keeps the Client,
[mqtt-connection](http://npm.im/mqtt-connection) includes the barebone
Connection code for server-side usage, and [mqtt-packet](http://npm.im/mqtt-packet)
@@ -71,6 +79,7 @@ support for QoS 1 and 2. The previous API is still supported but
deprecated, as such, it is not documented in this README.
+
## Installation
```sh
@@ -78,30 +87,32 @@ npm install mqtt --save
```
+
## Example
For the sake of simplicity, let's put the subscriber and the publisher in the same file:
```js
-const mqtt = require('mqtt')
-const client = mqtt.connect('mqtt://test.mosquitto.org')
+const mqtt = require("mqtt");
+const client = mqtt.connect("mqtt://test.mosquitto.org");
-client.on('connect', function () {
- client.subscribe('presence', function (err) {
+client.on("connect", function () {
+ client.subscribe("presence", function (err) {
if (!err) {
- client.publish('presence', 'Hello mqtt')
+ client.publish("presence", "Hello mqtt");
}
- })
-})
+ });
+});
-client.on('message', function (topic, message) {
+client.on("message", function (topic, message) {
// message is Buffer
- console.log(message.toString())
- client.end()
-})
+ console.log(message.toString());
+ client.end();
+});
```
output:
+
```
Hello mqtt
```
@@ -118,30 +129,40 @@ If you do not want to install a separate broker, you can try using the
to use MQTT.js in the browser see the [browserify](#browserify) section
+
## Import styles
+
### CommonJS (Require)
+
```js
-const mqtt = require('mqtt') // require mqtt
-const client = mqtt.connect('est.mosquitto.org') // create a client
+const mqtt = require("mqtt"); // require mqtt
+const client = mqtt.connect("est.mosquitto.org"); // create a client
```
+
### ES6 Modules (Import)
+
#### Aliased wildcard import
+
```js
-import * as mqtt from "mqtt" // import everything inside the mqtt module and give it the namespace "mqtt"
-let client = mqtt.connect('mqtt://test.mosquitto.org') // create a client
+import * as mqtt from "mqtt"; // import everything inside the mqtt module and give it the namespace "mqtt"
+let client = mqtt.connect("mqtt://test.mosquitto.org"); // create a client
```
+
#### Importing individual components
+
```js
-import { connect } from "mqtt" // import connect from mqtt
-let client = connect('mqtt://test.mosquitto.org') // create a client
+import { connect } from "mqtt"; // import connect from mqtt
+let client = connect("mqtt://test.mosquitto.org"); // create a client
```
+
## Promise support
If you want to use the new [async-await](https://blog.risingstack.com/async-await-node-js-7-nightly/) functionality in JavaScript, or just prefer using Promises instead of callbacks, [async-mqtt](https://github.com/mqttjs/async-mqtt) is a wrapper over MQTT.js which uses promises instead of callbacks when possible.
+
## Command Line Tools
MQTT.js bundles a command to interact with a broker.
@@ -167,9 +188,11 @@ mqtt pub -t 'hello' -h 'test.mosquitto.org' -m 'from MQTT.js'
See `mqtt help ` for the command help.
+
## Debug Logs
MQTT.js uses the [debug](https://www.npmjs.com/package/debug#cmd) package for debugging purposes. To enable debug logs, add the following environment variable on runtime :
+
```ps
# (example using PowerShell, the VS Code default)
$env:DEBUG='mqttjs*'
@@ -177,6 +200,7 @@ $env:DEBUG='mqttjs*'
```
+
## About Reconnection
An important part of any websocket connection is what to do when a connection
@@ -198,6 +222,7 @@ To address this we can use a hook called `transformWsUrl` to manipulate
either of the connection url or the client options at the time of a reconnect.
Example (update clientId & username on each reconnect):
+
```
const transformWsUrl = (url, options, client) => {
client.options.username = `token=${this.get_current_auth_token()}`;
@@ -212,6 +237,7 @@ Example (update clientId & username on each reconnect):
});
```
+
Now every time a new WebSocket connection is opened (hopefully not too often),
we will get a fresh signed url or fresh auth token data.
@@ -220,7 +246,6 @@ use the latest auth token, you must have some outside mechanism running that
handles application-level authentication refreshing so that the websocket
connection can simply grab the latest valid token or signed url.
-
#### Enabling Reconnection with `reconnectPeriod` option
To ensure that the mqtt client automatically tries to reconnect when the
@@ -232,12 +257,15 @@ The default value is 1000 ms which means it will try to reconnect 1 second
after losing the connection.
+
## About Topic Alias Management
### Enabling automatic Topic Alias using
+
If the client sets the option `autoUseTopicAlias:true` then MQTT.js uses existing topic alias automatically.
example scenario:
+
```
1. PUBLISH topic:'t1', ta:1 (register)
2. PUBLISH topic:'t1' -> topic:'', ta:1 (auto use existing map entry)
@@ -250,12 +278,13 @@ User doesn't need to manage which topic is mapped to which topic alias.
If the user want to register topic alias, then publish topic with topic alias.
If the user want to use topic alias, then publish topic without topic alias. If there is a mapped topic alias then added it as a property and update the topic to empty string.
-### Enabling automatic Topic Alias assign
+### Enabling automatic Topic Alias assign
If the client sets the option `autoAssignTopicAlias:true` then MQTT.js uses existing topic alias automatically.
If no topic alias exists, then assign a new vacant topic alias automatically. If topic alias is fully used, then LRU(Least Recently Used) topic-alias entry is overwritten.
example scenario:
+
```
The broker returns CONNACK (TopicAliasMaximum:3)
1. PUBLISH topic:'t1' -> 't1', ta:1 (auto assign t1:1 and register)
@@ -268,28 +297,31 @@ The broker returns CONNACK (TopicAliasMaximum:3)
Also user can manually register topic-alias pair using PUBLISH topic:'some', ta:X. It works well with automatic topic alias assign.
+
## API
- * mqtt.connect()
- * mqtt.Client()
- * mqtt.Client#publish()
- * mqtt.Client#subscribe()
- * mqtt.Client#unsubscribe()
- * mqtt.Client#end()
- * mqtt.Client#removeOutgoingMessage()
- * mqtt.Client#reconnect()
- * mqtt.Client#handleMessage()
- * mqtt.Client#connected
- * mqtt.Client#reconnecting
- * mqtt.Client#getLastMessageId()
- * mqtt.Store()
- * mqtt.Store#put()
- * mqtt.Store#del()
- * mqtt.Store#createStream()
- * mqtt.Store#close()
-
--------------------------------------------------------
+- mqtt.connect()
+- mqtt.Client()
+- mqtt.Client#publish()
+- mqtt.Client#subscribe()
+- mqtt.Client#unsubscribe()
+- mqtt.Client#end()
+- mqtt.Client#removeOutgoingMessage()
+- mqtt.Client#reconnect()
+- mqtt.Client#handleMessage()
+- mqtt.Client#connected
+- mqtt.Client#reconnecting
+- mqtt.Client#getLastMessageId()
+- mqtt.Store()
+- mqtt.Store#put()
+- mqtt.Store#del()
+- mqtt.Store#createStream()
+- mqtt.Store#close()
+
+---
+
+
### mqtt.connect([url], options)
Connects to the broker specified by the given url and options and
@@ -308,8 +340,10 @@ at every connect.
For all MQTT-related options, see the [Client](#client)
constructor.
--------------------------------------------------------
+---
+
+
### mqtt.Client(streamBuilder, options)
The `Client` class wraps a client connection to an
@@ -318,72 +352,72 @@ WebSocket, ecc).
`Client` automatically handles the following:
-* Regular server pings
-* QoS flow
-* Automatic reconnections
-* Start publishing before being connected
+- Regular server pings
+- QoS flow
+- Automatic reconnections
+- Start publishing before being connected
The arguments are:
-* `streamBuilder` is a function that returns a subclass of the `Stream` class that supports
-the `connect` event. Typically a `net.Socket`.
-* `options` is the client connection options (see: the [connect packet](https://github.com/mcollina/mqtt-packet#connect)). Defaults:
- * `wsOptions`: is the WebSocket connection options. Default is `{}`.
- It's specific for WebSockets. For possible options have a look at: https://github.com/websockets/ws/blob/master/doc/ws.md.
- * `keepalive`: `60` seconds, set to `0` to disable
- * `reschedulePings`: reschedule ping messages after sending packets (default `true`)
- * `clientId`: `'mqttjs_' + Math.random().toString(16).substr(2, 8)`
- * `protocolId`: `'MQTT'`
- * `protocolVersion`: `4`
- * `clean`: `true`, set to false to receive QoS 1 and 2 messages while
+- `streamBuilder` is a function that returns a subclass of the `Stream` class that supports
+ the `connect` event. Typically a `net.Socket`.
+- `options` is the client connection options (see: the [connect packet](https://github.com/mcollina/mqtt-packet#connect)). Defaults:
+ - `wsOptions`: is the WebSocket connection options. Default is `{}`.
+ It's specific for WebSockets. For possible options have a look at: https://github.com/websockets/ws/blob/master/doc/ws.md.
+ - `keepalive`: `60` seconds, set to `0` to disable
+ - `reschedulePings`: reschedule ping messages after sending packets (default `true`)
+ - `clientId`: `'mqttjs_' + Math.random().toString(16).substr(2, 8)`
+ - `protocolId`: `'MQTT'`
+ - `protocolVersion`: `4`
+ - `clean`: `true`, set to false to receive QoS 1 and 2 messages while
offline
- * `reconnectPeriod`: `1000` milliseconds, interval between two
+ - `reconnectPeriod`: `1000` milliseconds, interval between two
reconnections. Disable auto reconnect by setting to `0`.
- * `connectTimeout`: `30 * 1000` milliseconds, time to wait before a
+ - `connectTimeout`: `30 * 1000` milliseconds, time to wait before a
CONNACK is received
- * `username`: the username required by your broker, if any
- * `password`: the password required by your broker, if any
- * `incomingStore`: a [Store](#store) for the incoming packets
- * `outgoingStore`: a [Store](#store) for the outgoing packets
- * `queueQoSZero`: if connection is broken, queue outgoing QoS zero messages (default `true`)
- * `customHandleAcks`: MQTT 5 feature of custom handling puback and pubrec packets. Its callback:
- ```js
- customHandleAcks: function(topic, message, packet, done) {/*some logic wit colling done(error, reasonCode)*/}
- ```
- * `autoUseTopicAlias`: enabling automatic Topic Alias using functionality
- * `autoAssignTopicAlias`: enabling automatic Topic Alias assign functionality
- * `properties`: properties MQTT 5.0.
- `object` that supports the following properties:
- * `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
- * `receiveMaximum`: representing the Receive Maximum value `number`,
- * `maximumPacketSize`: representing the Maximum Packet Size the Client is willing to accept `number`,
- * `topicAliasMaximum`: representing the Topic Alias Maximum value indicates the highest value that the Client will accept as a Topic Alias sent by the Server `number`,
- * `requestResponseInformation`: The Client uses this value to request the Server to return Response Information in the CONNACK `boolean`,
- * `requestProblemInformation`: The Client uses this value to indicate whether the Reason String or User Properties are sent in the case of failures `boolean`,
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
- * `authenticationMethod`: the name of the authentication method used for extended authentication `string`,
- * `authenticationData`: Binary Data containing authentication data `binary`
- * `authPacket`: settings for auth packet `object`
- * `will`: a message that will sent by the broker automatically when
- the client disconnect badly. The format is:
- * `topic`: the topic to publish
- * `payload`: the message to publish
- * `qos`: the QoS
- * `retain`: the retain flag
- * `properties`: properties of will by MQTT 5.0:
- * `willDelayInterval`: representing the Will Delay Interval in seconds `number`,
- * `payloadFormatIndicator`: Will Message is UTF-8 Encoded Character Data or not `boolean`,
- * `messageExpiryInterval`: value is the lifetime of the Will Message in seconds and is sent as the Publication Expiry Interval when the Server publishes the Will Message `number`,
- * `contentType`: describing the content of the Will Message `string`,
- * `responseTopic`: String which is used as the Topic Name for a response message `string`,
- * `correlationData`: The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
- * `transformWsUrl` : optional `(url, options, client) => url` function
- For ws/wss protocols only. Can be used to implement signing
- urls which upon reconnect can have become expired.
- * `resubscribe` : if connection is broken and reconnects,
- subscribed topics are automatically subscribed again (default `true`)
- * `messageIdProvider`: custom messageId provider. when `new UniqueMessageIdProvider()` is set, then non conflict messageId is provided.
+ - `username`: the username required by your broker, if any
+ - `password`: the password required by your broker, if any
+ - `incomingStore`: a [Store](#store) for the incoming packets
+ - `outgoingStore`: a [Store](#store) for the outgoing packets
+ - `queueQoSZero`: if connection is broken, queue outgoing QoS zero messages (default `true`)
+ - `customHandleAcks`: MQTT 5 feature of custom handling puback and pubrec packets. Its callback:
+ ```js
+ customHandleAcks: function(topic, message, packet, done) {/*some logic wit colling done(error, reasonCode)*/}
+ ```
+ - `autoUseTopicAlias`: enabling automatic Topic Alias using functionality
+ - `autoAssignTopicAlias`: enabling automatic Topic Alias assign functionality
+ - `properties`: properties MQTT 5.0.
+ `object` that supports the following properties:
+ - `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
+ - `receiveMaximum`: representing the Receive Maximum value `number`,
+ - `maximumPacketSize`: representing the Maximum Packet Size the Client is willing to accept `number`,
+ - `topicAliasMaximum`: representing the Topic Alias Maximum value indicates the highest value that the Client will accept as a Topic Alias sent by the Server `number`,
+ - `requestResponseInformation`: The Client uses this value to request the Server to return Response Information in the CONNACK `boolean`,
+ - `requestProblemInformation`: The Client uses this value to indicate whether the Reason String or User Properties are sent in the case of failures `boolean`,
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
+ - `authenticationMethod`: the name of the authentication method used for extended authentication `string`,
+ - `authenticationData`: Binary Data containing authentication data `binary`
+ - `authPacket`: settings for auth packet `object`
+ - `will`: a message that will sent by the broker automatically when
+ the client disconnect badly. The format is:
+ - `topic`: the topic to publish
+ - `payload`: the message to publish
+ - `qos`: the QoS
+ - `retain`: the retain flag
+ - `properties`: properties of will by MQTT 5.0:
+ - `willDelayInterval`: representing the Will Delay Interval in seconds `number`,
+ - `payloadFormatIndicator`: Will Message is UTF-8 Encoded Character Data or not `boolean`,
+ - `messageExpiryInterval`: value is the lifetime of the Will Message in seconds and is sent as the Publication Expiry Interval when the Server publishes the Will Message `number`,
+ - `contentType`: describing the content of the Will Message `string`,
+ - `responseTopic`: String which is used as the Topic Name for a response message `string`,
+ - `correlationData`: The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
+ - `transformWsUrl` : optional `(url, options, client) => url` function
+ For ws/wss protocols only. Can be used to implement signing
+ urls which upon reconnect can have become expired.
+ - `resubscribe` : if connection is broken and reconnects,
+ subscribed topics are automatically subscribed again (default `true`)
+ - `messageIdProvider`: custom messageId provider. when `new UniqueMessageIdProvider()` is set, then non conflict messageId is provided.
In case mqtts (mqtt over tls) is required, the `options` object is
passed through to
@@ -410,9 +444,10 @@ version 1.3 and 1.4 works fine without those.
`function (connack) {}`
Emitted on successful (re)connection (i.e. connack rc=0).
-* `connack` received connack packet. When `clean` connection option is `false` and server has a previous session
-for `clientId` connection option, then `connack.sessionPresent` flag is `true`. When that is the case,
-you may rely on stored session and prefer not to send subscribe commands for the client.
+
+- `connack` received connack packet. When `clean` connection option is `false` and server has a previous session
+ for `clientId` connection option, then `connack.sessionPresent` flag is `true`. When that is the case,
+ you may rely on stored session and prefer not to send subscribe commands for the client.
#### Event `'reconnect'`
@@ -447,10 +482,10 @@ parsing error occurs.
The following TLS errors will be emitted as an `error` event:
-* `ECONNREFUSED`
-* `ECONNRESET`
-* `EADDRINUSE`
-* `ENOTFOUND`
+- `ECONNREFUSED`
+- `ECONNRESET`
+- `EADDRINUSE`
+- `ENOTFOUND`
#### Event `'end'`
@@ -465,9 +500,10 @@ callback returns.
`function (topic, message, packet) {}`
Emitted when the client receives a publish packet
-* `topic` topic of the received packet
-* `message` payload of the received packet
-* `packet` received packet, as defined in
+
+- `topic` topic of the received packet
+- `message` payload of the received packet
+- `packet` received packet, as defined in
[mqtt-packet](https://github.com/mcollina/mqtt-packet#publish)
#### Event `'packetsend'`
@@ -476,7 +512,8 @@ Emitted when the client receives a publish packet
Emitted when the client sends any packet. This includes .published() packets
as well as packets used by MQTT for managing subscriptions and connections
-* `packet` received packet, as defined in
+
+- `packet` received packet, as defined in
[mqtt-packet](https://github.com/mcollina/mqtt-packet)
#### Event `'packetreceive'`
@@ -486,92 +523,103 @@ as well as packets used by MQTT for managing subscriptions and connections
Emitted when the client receives any packet. This includes packets from
subscribed topics as well as packets used by MQTT for managing subscriptions
and connections
-* `packet` received packet, as defined in
+
+- `packet` received packet, as defined in
[mqtt-packet](https://github.com/mcollina/mqtt-packet)
--------------------------------------------------------
+---
+
+
### mqtt.Client#publish(topic, message, [options], [callback])
Publish a message to a topic
-* `topic` is the topic to publish to, `String`
-* `message` is the message to publish, `Buffer` or `String`
-* `options` is the options to publish with, including:
- * `qos` QoS level, `Number`, default `0`
- * `retain` retain flag, `Boolean`, default `false`
- * `dup` mark as duplicate flag, `Boolean`, default `false`
- * `properties`: MQTT 5.0 properties `object`
- * `payloadFormatIndicator`: Payload is UTF-8 Encoded Character Data or not `boolean`,
- * `messageExpiryInterval`: the lifetime of the Application Message in seconds `number`,
- * `topicAlias`: value that is used to identify the Topic instead of using the Topic Name `number`,
- * `responseTopic`: String which is used as the Topic Name for a response message `string`,
- * `correlationData`: used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
- * `subscriptionIdentifier`: representing the identifier of the subscription `number`,
- * `contentType`: String describing the content of the Application Message `string`
- * `cbStorePut` - `function ()`, fired when message is put into `outgoingStore` if QoS is `1` or `2`.
-* `callback` - `function (err)`, fired when the QoS handling completes,
+- `topic` is the topic to publish to, `String`
+- `message` is the message to publish, `Buffer` or `String`
+- `options` is the options to publish with, including:
+ - `qos` QoS level, `Number`, default `0`
+ - `retain` retain flag, `Boolean`, default `false`
+ - `dup` mark as duplicate flag, `Boolean`, default `false`
+ - `properties`: MQTT 5.0 properties `object`
+ - `payloadFormatIndicator`: Payload is UTF-8 Encoded Character Data or not `boolean`,
+ - `messageExpiryInterval`: the lifetime of the Application Message in seconds `number`,
+ - `topicAlias`: value that is used to identify the Topic instead of using the Topic Name `number`,
+ - `responseTopic`: String which is used as the Topic Name for a response message `string`,
+ - `correlationData`: used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
+ - `subscriptionIdentifier`: representing the identifier of the subscription `number`,
+ - `contentType`: String describing the content of the Application Message `string`
+ - `cbStorePut` - `function ()`, fired when message is put into `outgoingStore` if QoS is `1` or `2`.
+- `callback` - `function (err)`, fired when the QoS handling completes,
or at the next tick if QoS 0. An error occurs if client is disconnecting.
--------------------------------------------------------
+---
+
+
### mqtt.Client#subscribe(topic/topic array/topic object, [options], [callback])
Subscribe to a topic or topics
-* `topic` is a `String` topic to subscribe to or an `Array` of
+- `topic` is a `String` topic to subscribe to or an `Array` of
topics to subscribe to. It can also be an object, it has as object
keys the topic name and as value the QoS, like `{'test1': {qos: 0}, 'test2': {qos: 1}}`.
MQTT `topic` wildcard characters are supported (`+` - for single level and `#` - for multi level)
-* `options` is the options to subscribe with, including:
- * `qos` QoS subscription level, default 0
- * `nl` No Local MQTT 5.0 flag (If the value is true, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing connection)
- * `rap` Retain as Published MQTT 5.0 flag (If true, Application Messages forwarded using this subscription keep the RETAIN flag they were published with. If false, Application Messages forwarded using this subscription have the RETAIN flag set to 0.)
- * `rh` Retain Handling MQTT 5.0 (This option specifies whether retained messages are sent when the subscription is established.)
- * `properties`: `object`
- * `subscriptionIdentifier`: representing the identifier of the subscription `number`,
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
-* `callback` - `function (err, granted)`
+- `options` is the options to subscribe with, including:
+ - `qos` QoS subscription level, default 0
+ - `nl` No Local MQTT 5.0 flag (If the value is true, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing connection)
+ - `rap` Retain as Published MQTT 5.0 flag (If true, Application Messages forwarded using this subscription keep the RETAIN flag they were published with. If false, Application Messages forwarded using this subscription have the RETAIN flag set to 0.)
+ - `rh` Retain Handling MQTT 5.0 (This option specifies whether retained messages are sent when the subscription is established.)
+ - `properties`: `object`
+ - `subscriptionIdentifier`: representing the identifier of the subscription `number`,
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
+- `callback` - `function (err, granted)`
callback fired on suback where:
- * `err` a subscription error or an error that occurs when client is disconnecting
- * `granted` is an array of `{topic, qos}` where:
- * `topic` is a subscribed to topic
- * `qos` is the granted QoS level on it
+ - `err` a subscription error or an error that occurs when client is disconnecting
+ - `granted` is an array of `{topic, qos}` where:
+ - `topic` is a subscribed to topic
+ - `qos` is the granted QoS level on it
+
+---
--------------------------------------------------------
+
### mqtt.Client#unsubscribe(topic/topic array, [options], [callback])
Unsubscribe from a topic or topics
-* `topic` is a `String` topic or an array of topics to unsubscribe from
-* `options`: options of unsubscribe.
- * `properties`: `object`
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
-* `callback` - `function (err)`, fired on unsuback. An error occurs if client is disconnecting.
+- `topic` is a `String` topic or an array of topics to unsubscribe from
+- `options`: options of unsubscribe.
+ - `properties`: `object`
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`
+- `callback` - `function (err)`, fired on unsuback. An error occurs if client is disconnecting.
+
+---
--------------------------------------------------------
+
### mqtt.Client#end([force], [options], [callback])
Close the client, accepts the following options:
-* `force`: passing it to true will close the client right away, without
+- `force`: passing it to true will close the client right away, without
waiting for the in-flight messages to be acked. This parameter is
optional.
-* `options`: options of disconnect.
- * `reasonCode`: Disconnect Reason Code `number`
- * `properties`: `object`
- * `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
- * `reasonString`: representing the reason for the disconnect `string`,
- * `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
- * `serverReference`: String which can be used by the Client to identify another Server to use `string`
-* `callback`: will be called when the client is closed. This parameter is
+- `options`: options of disconnect.
+ - `reasonCode`: Disconnect Reason Code `number`
+ - `properties`: `object`
+ - `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
+ - `reasonString`: representing the reason for the disconnect `string`,
+ - `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
+ - `serverReference`: String which can be used by the Client to identify another Server to use `string`
+- `callback`: will be called when the client is closed. This parameter is
optional.
--------------------------------------------------------
+---
+
+
### mqtt.Client#removeOutgoingMessage(mId)
Remove a message from the outgoingStore.
@@ -579,95 +627,117 @@ The outgoing callback will be called with Error('Message removed') if the messag
After this function is called, the messageId is released and becomes reusable.
-* `mId`: The messageId of the message in the outgoingStore.
+- `mId`: The messageId of the message in the outgoingStore.
+
+---
--------------------------------------------------------
+
### mqtt.Client#reconnect()
Connect again using the same options as connect()
--------------------------------------------------------
+---
+
+
### mqtt.Client#handleMessage(packet, callback)
Handle messages with backpressure support, one at a time.
-Override at will, but __always call `callback`__, or the client
+Override at will, but **always call `callback`**, or the client
will hang.
--------------------------------------------------------
+---
+
+
### mqtt.Client#connected
Boolean : set to `true` if the client is connected. `false` otherwise.
--------------------------------------------------------
+---
+
+
### mqtt.Client#getLastMessageId()
Number : get last message id. This is for sent messages only.
--------------------------------------------------------
+---
+
+
### mqtt.Client#reconnecting
Boolean : set to `true` if the client is trying to reconnect to the server. `false` otherwise.
--------------------------------------------------------
+---
+
+
### mqtt.Store(options)
In-memory implementation of the message store.
-* `options` is the store options:
- * `clean`: `true`, clean inflight messages when close is called (default `true`)
+- `options` is the store options:
+ - `clean`: `true`, clean inflight messages when close is called (default `true`)
Other implementations of `mqtt.Store`:
-* [mqtt-jsonl-store](https://github.com/robertsLando/mqtt-jsonl-store) which uses
+- [mqtt-jsonl-store](https://github.com/robertsLando/mqtt-jsonl-store) which uses
[jsonl-db](https://github.com/AlCalzone/jsonl-db) to store inflight data, it works only on Node.
-* [mqtt-level-store](http://npm.im/mqtt-level-store) which uses
+- [mqtt-level-store](http://npm.im/mqtt-level-store) which uses
[Level-browserify](http://npm.im/level-browserify) to store the inflight
data, making it usable both in Node and the Browser.
-* [mqtt-nedb-store](https://github.com/behrad/mqtt-nedb-store) which
+- [mqtt-nedb-store](https://github.com/behrad/mqtt-nedb-store) which
uses [nedb](https://www.npmjs.com/package/nedb) to store the inflight
data.
-* [mqtt-localforage-store](http://npm.im/mqtt-localforage-store) which uses
+- [mqtt-localforage-store](http://npm.im/mqtt-localforage-store) which uses
[localForage](http://npm.im/localforage) to store the inflight
data, making it usable in the Browser without browserify.
--------------------------------------------------------
+---
+
+
### mqtt.Store#put(packet, callback)
Adds a packet to the store, a packet is
anything that has a `messageId` property.
The callback is called when the packet has been stored.
--------------------------------------------------------
+---
+
+
### mqtt.Store#createStream()
Creates a stream with all the packets in the store.
--------------------------------------------------------
+---
+
+
### mqtt.Store#del(packet, cb)
Removes a packet from the store, a packet is
anything that has a `messageId` property.
The callback is called when the packet has been removed.
--------------------------------------------------------
+---
+
+
### mqtt.Store#close(cb)
Closes the Store.
+
## Browser
+
### Via CDN
The MQTT.js bundle is available through http://unpkg.com, specifically
@@ -675,6 +745,7 @@ at https://unpkg.com/mqtt/dist/mqtt.min.js.
See http://unpkg.com for the full documentation on version ranges.
+
### Browserify
In order to use MQTT.js as a browserify module you can either require it in your browserify bundles or build it as a stand alone module. The exported module is AMD/CommonJs compatible and it will add an object in the global space.
@@ -695,6 +766,7 @@ gzip
+
### Webpack
Just like browserify, export MQTT.js as library. The exported module would be `const mqtt = xxx` and it will add an object in the global space. You could also export module in other [formats (AMD/CommonJS/others)](http://webpack.github.io/docs/configuration.html#output-librarytarget) by setting **output.libraryTarget** in webpack configuration.
@@ -711,27 +783,28 @@ you can then use mqtt.js in the browser with the same api than node's one.
```html
-
- test Ws mqtt.js
-
-
-
-
-
+
+ test Ws mqtt.js
+
+
+
+
+
```
### React
+
```
npm install -g webpack // Install webpack globally
npm install mqtt // Install MQTT library
@@ -742,7 +815,6 @@ webpack mqtt.js --output-library mqtt // Build
// now you can import the library with ES6 import, commonJS not tested
```
-
```javascript
import React from 'react';
import mqtt from 'mqtt';
@@ -772,56 +844,67 @@ export default () => {
Your broker should accept websocket connection (see [MQTT over Websockets](https://github.com/moscajs/aedes/blob/master/docs/Examples.md#mqtt-server-over-websocket-using-server-factory) to setup [Aedes](https://github.com/moscajs/aedes)).
+
## About QoS
Here is how QoS works:
-* QoS 0 : received **at most once** : The packet is sent, and that's it. There is no validation about whether it has been received.
-* QoS 1 : received **at least once** : The packet is sent and stored as long as the client has not received a confirmation from the server. MQTT ensures that it *will* be received, but there can be duplicates.
-* QoS 2 : received **exactly once** : Same as QoS 1 but there is no duplicates.
+- QoS 0 : received **at most once** : The packet is sent, and that's it. There is no validation about whether it has been received.
+- QoS 1 : received **at least once** : The packet is sent and stored as long as the client has not received a confirmation from the server. MQTT ensures that it _will_ be received, but there can be duplicates.
+- QoS 2 : received **exactly once** : Same as QoS 1 but there is no duplicates.
About data consumption, obviously, QoS 2 > QoS 1 > QoS 0, if that's a concern to you.
+
## Usage with TypeScript
+
This repo bundles TypeScript definition files for use in TypeScript projects and to support tools that can read `.d.ts` files.
### Pre-requisites
+
Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets these requirements:
- * TypeScript >= 2.1
- * Set tsconfig.json: `{"compilerOptions" : {"moduleResolution" : "node"}, ...}`
- * Includes the TypeScript definitions for Node and [ws](https://www.npmjs.com/package/ws). These types are used as
- parameters to some of the MQTT client's APIs and if you don't install them they get treated as `any`, which means you lose type
- safety.
- Use npm to install them by typing the following into a terminal window:
- `npm install --save-dev @types/node @types/ws`
+
+- TypeScript >= 2.1
+- Set tsconfig.json: `{"compilerOptions" : {"moduleResolution" : "node"}, ...}`
+- Includes the TypeScript definitions for Node and [ws](https://www.npmjs.com/package/ws). These types are used as
+ parameters to some of the MQTT client's APIs and if you don't install them they get treated as `any`, which means you lose type
+ safety.
+ Use npm to install them by typing the following into a terminal window:
+ `npm install --save-dev @types/node @types/ws`
### TypeScript example
+
```
import * as mqtt from "mqtt"
let client : mqtt.MqttClient = mqtt.connect('mqtt://test.mosquitto.org')
```
+
## WeChat and Ali Mini Program support
+
### WeChat Mini Program
+
Supports [WeChat Mini Program](https://mp.weixin.qq.com/). Use the `wxs` protocol. See [the WeChat docs](https://mp.weixin.qq.com/debug/wxadoc/dev/api/network-socket.html).
```js
-const mqtt = require('mqtt')
-const client = mqtt.connect('wxs://test.mosquitto.org')
+const mqtt = require("mqtt");
+const client = mqtt.connect("wxs://test.mosquitto.org");
```
### Ali Mini Program
+
Supports [Ali Mini Program](https://open.alipay.com/channel/miniIndex.htm). Use the `alis` protocol. See [the Alipay docs](https://docs.alipay.com/mini/developer/getting-started).
```js
-const mqtt = require('mqtt')
-const client = mqtt.connect('alis://test.mosquitto.org')
+const mqtt = require("mqtt");
+const client = mqtt.connect("alis://test.mosquitto.org");
```
+
## Contributing
MQTT.js is an **OPEN Open Source Project**. This means that:
@@ -834,15 +917,25 @@ See the [CONTRIBUTING.md](https://github.com/mqttjs/MQTT.js/blob/master/CONTRIBU
MQTT.js is only possible due to the excellent work of the following contributors:
-
+| Name | GitHub | Twitter |
+| ------------------ | -------------------------------------------------- | ---------------------------------------------------------- |
+| Adam Rudd | [GitHub/adamvr](https://github.com/adamvr) | [Twitter/@adam_vr](http://twitter.com/adam_vr) |
+| Matteo Collina | [GitHub/mcollina](https://github.com/mcollina) | [Twitter/@matteocollina](http://twitter.com/matteocollina) |
+| Maxime Agor | [GitHub/4rzael](https://github.com/4rzael) | [Twitter/@4rzael](http://twitter.com/4rzael) |
+| Siarhei Buntsevich | [GitHub/scarry1992](https://github.com/scarry1992) | |
+| Daniel Lando | [GitHub/robertsLando](https://github.com/robertsLando) | |
+
+
+
+## Sponsor
+If you would like to support MQTT.js, please consider sponsoring the author and active maintainers:
+
+- [Matteo Collina](https://github.com/sponsors/mcollina): author of MQTT.js
+- [Daniel Lando](https://github.com/sponsors/robertsLando): active maintainer
+
## License
MIT