Koa compatible wrapper to support Secure WebSockets
Last updated a year ago by twoseventythree .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install koa-wss 
SYNC missed versions from official npm registry.


:blue_heart: Support wss:// in your Koa app :blue_heart:

This is a fork/copy of the excellent package koa-websocket by Jonathan Cremin, with secure Web Socket functionality added.

Koa's listen method just calls http.createServer(options).listen(...), so this calls https.createServer(options).listen(...) instead and provides a parameter to pass in the HTTPS options (like the certificate and stuff).

If you don't supply an httpsOptions argument, koa-wss will do what koa-websocket does and just use Koa's built-in listen method.

See Koa's docs about this here.


npm install koa-wss --save


Example with Let's Encrypt (the Greenlock package):

const Koa = require('koa');
const greenlock = require('greenlock-express');
const websockify = require('koa-wss');

const le = greenlock.create({
  // all your sweet Let's Encrypt options here

// the magic happens right here
const app = websockify(new Koa(), wsOptions, le.httpsOptions);

// async/await is of course supported
app.ws.use(async (ctx, next) => {
   // the websocket is added to the context as `ctx.websocket`.
  await bananas();
  ctx.websocket.on('message', function(message) {
    // do something


Another example:

const fs = require('fs');
const path = require('path');
const Koa = require('koa');
const route = require('koa-route');
const websockify = require('koa-wss');

// using a local certificate, but whatever you normally put in HTTPS options works here
const httpsOptions = {
  key: fs.readFileSync(path.resolve(__dirname, './test/certs/server.key')),
  cert: fs.readFileSync(path.resolve(__dirname, './test/certs/server.crt'))

// the main event
const app = websockify(new Koa(), {}, httpsOptions);

// Note it's app.ws.use and not app.use
// This example uses koa-route
app.ws.use(route.all('/test', (ctx, next) => {
  ctx.websocket.send('Hello World');
  ctx.websocket.on('message', (message) => {
    // do something with the message from client
  return next()



websockify(KoaApp, WebSocketOptions, httpsOptions)

The WebSocket options object just get passed right through to the new WebSocketServer call. koa-wss passes in { server: httpsServer } automatically because that's the whole point.

The HTTPS options object gets passed right into https.createServer(options). If you don't specify these options with your certificate info, it will just set up an HTTP Koa server (the default).



Maintainers (1)
Today 0
This Week 0
This Month 5
Last Day 0
Last Week 5
Last Month 7
Dependencies (4)
Dev Dependencies (8)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |