Skip to content

Commit a7e53eb

Browse files
committed
prefer strings for event types
1 parent 51c0750 commit a7e53eb

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/guides/js-waku/reliable-channels.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This is an experimental feature and has a number of [limitations](https://github
1212
## Import Waku SDK
1313

1414
```shell
15-
npm install @waku/[email protected]67a7287.0
15+
npm install @waku/[email protected]3e66a33.0
1616
```
1717

1818
Or using a CDN, note this is an ESM package so `type="module"` is needed.
@@ -21,9 +21,8 @@ Or using a CDN, note this is an ESM package so `type="module"` is needed.
2121
<script type="module">
2222
import {
2323
createLightNode,
24-
ReliableChannelEvent,
2524
ReliableChannel
26-
} from 'https://unpkg.com/@waku/[email protected]67a7287.0/bundle/index.js';
25+
} from 'https://unpkg.com/@waku/[email protected]3e66a33.0/bundle/index.js';
2726
2827
// Your code here
2928
@@ -74,7 +73,7 @@ This can be useful to give feedback to the user, or stop some action (e.g. sendi
7473
```js
7574
import { HealthStatus, WakuEvent } from "@waku/sdk";
7675

77-
node.events.addEventListener(WakuEvent.Health, (event) => {
76+
node.events.addEventListener("waku:health", (event) => {
7877
const health = event.detail;
7978

8079
if (health === HealthStatus.SufficientlyHealthy) {
@@ -138,9 +137,7 @@ Have a look at the [Protobuf installation](/guides/js-waku/#message-structure) g
138137
The reliable channel will emit incoming messages. To process them, simply add a listener:
139138

140139
```js
141-
import { ReliableChannelEvent } from "@waku/sdk";
142-
143-
this.reliableChannel.addEventListener(ReliableChannelEvent.InMessageReceived, (event) => {
140+
this.reliableChannel.addEventListener("message-received", (event) => {
144141
const wakuMessage = event.detail;
145142

146143
// decode your payload using the protobuf object previously created
@@ -172,25 +169,25 @@ Then, setup listeners so you can know when the message:
172169
- has encountered an error
173170

174171
```js
175-
import { ReliableChannel, ReliableChannelEvent } from "@waku/sdk";
172+
import { ReliableChannel } from "@waku/sdk";
176173

177174
// First, get the id to track the message
178175
const messageId = ReliableChannel.getMessageId(serialisedMessage)
179176

180-
reliableChannel.addEventListener(ReliableChannelEvent.OutMessageIrrecoverableError, (event) => {
177+
reliableChannel.addEventListener("sending-message-irrecoverable-error", (event) => {
181178
if (messageId === event.detail.messageId) {
182179
console.error('Failed to send message:', event.detail.error);
183180
// Show an error to the user
184181
}
185182
})
186183

187-
reliableChannel.addEventListener(ReliableChannelEvent.OutMessageSent, (event) => {
184+
reliableChannel.addEventListener("message-sent", (event) => {
188185
if (messageId === event.detail) {
189186
// Message sent, show '✔' to the user, etc
190187
}
191188
})
192189

193-
reliableChannel.addEventListener(ReliableChannelEvent.OutMessageAcknowledged, (event) => {
190+
reliableChannel.addEventListener("message-acknowledged", (event) => {
194191
if (messageId === event.detail) {
195192
// Message acknowledged by other participants, show '✔✔' to the user, etc
196193
}

0 commit comments

Comments
 (0)