@gaman/[email protected]

[angga7togk]

What's @gaman/websocket

@gaman/websocket is a GamanJS module for creating and managing WebSocket connections easily.

Installation

npm i ws @gaman/websocket

# if using typescript
npm i --save-dev @types/ws

Basic Example

initial websocket module

// index.ts
import { WebsocketGateway } from "@gaman/websocket"

defineBootstrap((app) => {
  const server = app.mountServer(':3431');
  WebsocketGateway.upgrade(server);
})

create websocket handler

// ChatWebsocket.ts
import { composeWebsocket } from "@gaman/websocket"

export default composeWebsocket((event) => {
  Log.info('Client joined: ' + event.clientId);
  
  event.onMessage((msg) => {
    event.send('your message: ' + msg);
  })
})

register websocket handler to routes

// AppRoutes.ts
export default autoComposeRoutes((route) => {
  route.ws('/chat', ChatWebsocket);
});

and then connect to ws://localhost:3431/chat
if you using wscat use this command wscat -c ws://localhost:3431/chat and then type message and enter

Websocket Middleware

create message middleware handler

// ChatWebsocketMiddleware.ts
import { composeWebsocketMiddleware } from "@gaman/websocket"

export default composeWebsocketMiddleware((event, next) => {
  if(event.message === 'bruh'){
     event.send('Badword character')
  }
  next();
})

register to your route

// AppRoutes.ts
export default autoComposeRoutes((route) => {
  route.ws('/chat', ChatWebsocket).middleware(ChatWebsocketMiddleware());
});

Full Changelog: https://github.com/7TogkID/gaman/compare/@gaman/[email protected]...@gaman/[email protected]

---

This discussion was created from the release @gaman/[email protected].