@forinda/kickjs-ws

WebSocket adapter for KickJS — decorator-driven handlers (@WsController, @OnConnect, @OnDisconnect, @OnMessage, @OnError), namespaces, rooms, heartbeat, optional auth resolver.

Install

kick add ws

Quick Example

// chat.ws-controller.ts
import { WsController, OnConnect, OnMessage, WsContext } from '@forinda/kickjs-ws'

@WsController('/chat')
export class ChatController {
  @OnConnect()
  onConnect(ctx: WsContext) {
    ctx.send('welcome', { id: ctx.socketId })
  }

  @OnMessage('say')
  onSay(ctx: WsContext) {
    ctx.broadcast('say', ctx.data)
  }
}

// src/index.ts
import { bootstrap } from '@forinda/kickjs'
import { WsAdapter } from '@forinda/kickjs-ws'
import { modules } from './modules'

export const app = await bootstrap({
  modules,
  adapters: [WsAdapter({ path: '/ws' })],
})

Clients connect to ws://localhost:3000/ws/chat.

Documentation

forinda.github.io/kick-js/guide/websockets

License

MIT