Skip to content

Commit

Permalink
feat: add websocket
Browse files Browse the repository at this point in the history
  • Loading branch information
lau1944 committed Sep 16, 2023
1 parent 2237a6d commit 7dcbe08
Showing 1 changed file with 46 additions and 3 deletions.
49 changes: 46 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
- [Middlewares](#middlewares)
- [Error handling](#error-handling)
- [Request and Response object](#request-and-response-object)
- [Future](#next)
- [Websocket](#websocket)


### Get started
Expand Down Expand Up @@ -224,9 +224,52 @@ const handler = (req, res) => {
}
```

### Next
# websocket

Server rendering, websocket
<br> To handle websocket request, just a few steps to do </br>

```js
app.ws((ws, msg) => {
// here to handle incoming message
ws.send(msg)
}, {
open: (ws) => {
console.log('Websocket is turned on')
}, close: (ws) => {
console.log('Websocket is closed')
}, drain: (ws) => {
console.log('Websocket is drained')
}
})
```

<br> To connect to your websocket server </br>

```js
const socket = new WebSocket("ws://localhost:3000");
const msg = 'Hello world'
// message is received
socket.addEventListener("message", event => {
console.log(event.data)
});

// socket opened
socket.addEventListener("open", event => {
console.log('Open')
// here to send message
socket.send(msg)
});

// socket closed
socket.addEventListener("close", event => {
console.log('Close')
});

// error handler
socket.addEventListener("error", event => {
console.log('Error')
});
```

[npm-url]: https://www.npmjs.com/package/bunrest
[npm-version-image]: https://badgen.net/npm/v/bunrest
Expand Down

0 comments on commit 7dcbe08

Please sign in to comment.