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-ws-cookie-helper

v1.1.0

Published

koa.js + ws.js cookie helper

Downloads

7

Readme

Build Status Coverage Status NPM version

#koa-ws-cookie-helper

koa.js + ws.js helper for accessing cookies from a WebSocket connection

Installation

$ npm install koa-ws-cookie-helper

Example

var koa = require('koa'),
    WebSocketServer = require('ws').Server,
    cookieHelper = require('koa-ws-cookie-helper'),
    app = koa();

var port = 3000;
app.keys = ['secret'];

app.server = app.listen(port);

var wss = new WebSocketServer({server: app.server});
wss.on('connection', function (client) {

  // first argument is of type WebSocket
  
  // tries to get value of cookie named 'foo'
  // e.g. for 'foo=bar', returns 'bar'
  var cookieValue = cookieHelper.get(client, 'foo', app.keys);

  // if you use unsigned cookies or 
  // don't care if the cookie is legit or not
  // omit the keys parameter
  cookieValue = cookieHelper.get(client, 'foo'); 

});

How does it work?

Browsers put any cookies from the same host into initial WebSocket handshake headers. This lets typical HTTP-session mechanisms to work with WebSockets. koa.js makes use of Cookies module to handle cookie management. Signed cookies are signed and verified using Keygrip. This module combines methods used by them to parse cookies in ws.upgradeReq.headers.cookie.

API

There is only a single public function:

###get(ws, name, [keys]) Returns value of the cookie named name, using keyset keys. Cookie is searched in 'Cookie' entry of handshake headers. If no cookie could be found or if the signed cookie does not match with any key in the keyset, returns undefined.

License

MIT