koa-websocket

koa-websocket

This is a pre-release for compatibility with Koa 2. Doing npm install koa-websocket will continue to give you 2.x until Koa 2 is stable.

Installation

npm install koa-websocket@next

Usage

const Koa = require('koa'),
  route = require('koa-route'),
  websockify = require('koa-websocket');

const app = websockify(new Koa());

// Regular middleware
// Note it's app.ws.use and not app.use
app.ws.use(function(ctx, next) {
  // return `next` to pass the context (ctx) on to the next ws middleware
  return next(ctx);
});

// Using routes
app.ws.use(route.all('/test/:id', function (ctx) {
  // `ctx` is the regular koa context created from the `ws` onConnection `socket.upgradeReq` object.
  // the websocket is added to the context on `ctx.websocket`.
  ctx.websocket.send('Hello World');
  ctx.websocket.on('message', function(message) {
    // do something with the message from client
    console.log(message);
  });
}));

app.listen(3000);

Changelog

v3.0.1

Because NPM wouldn't let me retroactively tag 3.0.0 as next instead of latest.