Skip to content

Commit 0602ab3

Browse files
committed
Merge pull request tuanpmt#3 from whokilledtheelectricmonk/patch-2
document message data format
2 parents 75414e2 + 90a3ee7 commit 0602ab3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,18 @@ mqtt.createClient({
121121
+ event: `connect` - client connected
122122
+ event: `closed` - client disconnected
123123
+ event: `error` - error
124-
+ event: `message` - data received with format {topic, data, retain}
124+
+ event: `message` - message object
125125
- `connect`: begin connection
126126
- `disconnect`: disconnect
127127
- `subscribe(topic, qos)`
128128
- `publish(topic, payload, qos, retain)`
129129

130+
* `message`
131+
- `retain`: *boolean* `false`
132+
- `qos`: *number* `2`
133+
- `data`: *string* `"test message"`
134+
- `topic`: *string* `"/data"`
135+
130136
## Todo
131137

132138
* [ ] todo

0 commit comments

Comments
 (0)