npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

koa-wss

v1.0.3

Published

Koa compatible wrapper to support Secure WebSockets

Downloads

27

Readme

koa-wss

: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.

Installation

npm install koa-wss --save

Usage

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
  });
});

app.listen(3000);

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
    console.log(message);
  });
  return next()
}));

app.listen(3000);

API

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).

License

MIT