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

command-center

v0.1.0

Published

socket.io 0.9 helper library

Downloads

7

Readme

node-command-center

The purpose of this module is to provide socket.io room helper functions and to centralize socket.io event handler management inside your express application.

Right now the support for chat rooms is built in, but this may be factored out into a separate module.

Features

  • Handles joining and leaving rooms (subscribe and unsubscribe events).
  • Handles client disconnections (disconnect event).
  • Manages room user lists, associates session and socket.
  • Provides helper functions to send a message to a user or to a room.

Socket.io events responded to

Event name: subscribe
Description: The socket/session subscribes to a room. Users in the room are notified.
eventData: Requires roomName => (string).

Event name: unsubscribe
Description: The socket/session unsubscribes from a room. Users in the room are notified.
eventData: Requires roomName => (string).

Event name: message
Description: The socket/session sends a message to a room. Users in the room are notified.
eventData: Requires roomName => (string), message => (string).

Event name: userList
Description: The socket/session requests the user list of a room.
eventData: Requires roomName => (string).

Module dependencies

socket.io - Used to bind between socket.io and node web server object.
session.socket.io - Used for associating the session and socket objects. TODO: More info.
underscore - Used for various helper functions.
util - (node built-in) used for various helper functions.
sanitize - Used for HTML sanitizing messages before sending them.

Implied dependencies

Node web server object (returned by http.createServer) - Passed to constructor as server.
Express (actually Connect middleware) session store - Passed to constructor as sessionStore.
Express (actually Connect middleware) cookie parser - Passed to constructor as cookieParser.
Express (actually Connect middleware) session object - Passed to initSession function, passed to socket.io events. Extended with rooms key, which is an array of room names that the session has subscribed to.

Using the client library

The client library in client/ is built using Require.js.

If your project already uses RequireJS you can use client/command-center-client.js.

If you would prefer a compiled, minified version which includes the client-side dependencies (jquery, underscore, socket.io-client - see component.json for version numbers) then use client/command-center-client.min.js.

To rebuild the minified version you should have requirejs installed globally using npm install -g requirejs and then run r.js -o client/command-center-client-min.js.

TODOs

  • Build an eventData validator, since validation of this gets repeated often.
  • Double check that the instructions for using the client library work.