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

v1.0.1

Published

Integrates ws with koa, featuring shared sessions and json-rpc 2.0 protocol

Downloads

35

Readme

Build Status npm version Coverage Status Dependency Status

koa-ws

Empower your koa.js application with realtime.

Features

  • Uses jsonrpc 2.0 protocol per default
  • Uses generators as method handlers
  • Simple API to register namespaced methods
  • Connects your sockets to the users session

Quick start

Installation

$ npm install koa-ws

Usage

Add realtime to your koa app with a couple of lines:

var koa = require('koa');
var koaws = require('koa-ws');
var app = koa();

var options = {
    serveClientFile: true,
    clientFilePath: '/koaws.js',
    heartbeat: true,
    heartbeatInterval: 5000
};

app.use(koaws(app, options));

app.listen(3000);

Register a simple method on the server:

app.ws.register('hello', function* () {
    this.result('world!');
});

Load the client library in the browser with require (var koaws = require('koa-ws/client')) or use the hosted version at /koaws.js.

Register a method on the client to recieve the session:

koaws.register('session', function (err, payload) {
    if (err) console.error('Something went wrong', err);
    console.log(payload) // should include our session
});

Connect to the server:

koaws.connect();

Call the method from the client:

koaws.method('hello', function (err, result) {
    if (err) console.error('Something went wrong', err);
    console.log(result) // should log 'world!'
});

Options

heartbeat (default: true)

If server/client should send hearbeats to eachother

heartbeatInterval (default: 5000)

How often the heartbeat should be sent

serveClientFile (default: true)

Will try and serve the client library file when this.path matches the clientFilePath option.

clientFilePath (default: /koaws.js)

Defines the path to match when serving the client library.

Examples

Namespaced methods

Register a namespace:

app.ws.register('user', {
    create: function* () {
        // create user
    },
    update: function* () {
        // update user
    },
    remove: function* () {
        // remove user
    }
});

On the client you can then emit:

  • user:create
  • user:update
  • user:remove

License

Copyright (c) 2014, Marcus Ekwall [email protected]

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.