u8-mqtt-packet

MQTT packet encoder and decoder using Uint8Array in ES Modules (ESM). Zero dependencies. Tree-shaking friendly. Suited for use in modern ES6 environments: the Browser, NodeJS, and Deno.

Consider u8-mqtt for QOS-0 and QOS-1 MQTT client communications.

Docs

• API docs
• Bare-bones Client docs -- import 'esm/client/web.min.js' for 14 KB
• See u8-mqtt for a more friendly MQTT client using this library. (for 16 KB)

Targeting MQTT-3.1.1 (v4) and MQTT-5.0.0 (v5) compatibility.

Use

1import {mqtt_session_v4} from 'u8-mqtt-packet'
2const [mqtt_decode, mqtt_encode] = mqtt_session_v4()
3
4const u8_pkt = mqtt_encode('connect', {
5  keep_alive: 60,
6  flags: 0,
7  client_id: 'readme',
8})
9
10console.log(u8_pkt)
11
12/*
13  Uint8Array(20) [16,18,0,4,77,81,84,84,4,0,0,60,0,6,114,101,97,100,109,101]
14*/
15
16
17console.log(mqtt_decode(u8_pkt))
18
19/*
20  [
21    {
22      b0: 16,
23      mqtt_level: 4,
24      flags: [Number (_connect_flags_): 0],
25      keep_alive: 60,
26      client_id: 'readme'
27    }
28  ]
29*/

Module size

module	brotli	minified
u8-mqtt-packet/esm/codec_v4_lean.min.js	1700 B	4886 B
u8-mqtt-packet/esm/codec_v5_lean.min.js	2388 B	7010 B
u8-mqtt-packet/esm/index.min.js	4144 B	14053 B

automated sizing report

MQTT Client sizes

minifeid	(x)	Project	Measurement
187.0KB	12x	MQTT.js	curl -sL https://cdn.jsdelivr.net/npm/mqtt@4.0.1/dist/mqtt.min.js | wc -c
32.3KB	2x	paho	curl -sL https://cdn.jsdelivr.net/npm/paho-mqtt@1.1.0/paho-mqtt.min.js | wc -c
19.9KB	1.3x	u8-mqtt v5	cat ./u8-mqtt/esm/web/v5.min.js | wc -c
15.5KB	1x	u8-mqtt v4	cat ./u8-mqtt/esm/web/v4.min.js | wc -c

Prior Art

The u8-mqtt-packet project was inspired by mqtt-packet written for NodeJS. The codecs of that project are written with a NodeJS ecosystem in mind: Buffer, EventEmitter, Streams.

License

BSD-2-Clause